ble_mesh: add ble mesh example description

diff --git a/examples/bluetooth/esp_ble_mesh/README.md b/examples/bluetooth/esp_ble_mesh/README.md
new file mode 100644 (file)
index 0000000..43ed0ca
--- /dev/null
+++ b/examples/bluetooth/esp_ble_mesh/README.md
@@ -0,0 +1,74 @@
+# ESP BLE Mesh Examples
+
+[ESP BLE Mesh]($IDF_PATH/components/bt/esp_ble_mesh/) is the official BLE Mesh stack of Espressif Systems. We will provide long-term support for new features, performance optimization, etc.
+
+Please help note that breaking changes may be introduced into ESP BLE Mesh on [minor IDF versions](https://docs.espressif.com/projects/esp-idf/en/latest/versions.html).
+
+Note: To use examples in this directory, you need to have Bluetooth enabled in configuration and Bluedroid selected as the host stack. ESP BLE Mesh will support NimBLE host soon, and currently the integration of NimBLE host with ESP BLE Mesh stack is under development.
+
+# Example Layout
+
+This directory includes examples to demonstrate BLE Mesh functionality based on Zephyr (https://github.com/zephyrproject-rtos/zephyr) Mesh stack.
+
+## ble_mesh_client_model
+
+This example shows how ESP32 acts as a BLE Mesh Node with Generic OnOff Client & Server Models in the Primary Element.
+
+See the [README.md](./ble_mesh_client_model/README.md) file in the example [ble_mesh_client_model](./ble_mesh_client_model/).
+
+## ble_mesh_console
+
+This example demonstrates how ESP BLE Mesh uses Console for message transmitting/receiving tests.
+
+### ble_mesh_node
+
+This example shows how ESP32 acts as a BLE Mesh Node and sends vendor messages for testing.
+
+See the [README.md](./ble_mesh_console/ble_mesh_node/README.md) file in the example [ble_mesh_node](./ble_mesh_console/ble_mesh_node/).
+
+### ble_mesh_provisioner
+
+This example shows how ESP32 acts as a BLE Mesh Provisioner and sends vendor messages for testing.
+
+See the [README.md](./ble_mesh_console/ble_mesh_provisioner/README.md) file in the example [ble_mesh_provisioner](./ble_mesh_console/ble_mesh_provisioner/).
+
+## ble_mesh_fast_provision
+
+This example illustrates the solution of ESP BLE Mesh Fast Provisioning.
+
+### ble_mesh_fast_prov_client
+
+This example shows how ESP32, acting as a BLE Mesh Fast Provisioning Client, provisions other unprovisioned devices and then control the nodes.
+
+See the [README.md](./ble_mesh_fast_provision/ble_mesh_fast_prov_client/README.md) file in the example [ble_mesh_fast_prov_client](./ble_mesh_fast_provision/ble_mesh_fast_prov_client/).
+
+### ble_mesh_fast_prov_server
+
+This example illustrates the process that:
+1. Firstly as a BLE Mesh Fast Provisioning Server, ESP32 is provisioned into a Node;
+2. and then provisions other unprovisioned devices as a Temporary Provisioner.
+
+See the [README.md](./ble_mesh_fast_provision/ble_mesh_fast_prov_server/README.md) file in the example [ble_mesh_fast_prov_server](./ble_mesh_fast_provision/ble_mesh_fast_prov_server/).
+
+## ble_mesh_node
+
+This example shows how ESP32 acts as a BLE Mesh Node with only Generic OnOff Server Model in the Primary Element.
+
+See the [README.md](./ble_mesh_node/README.md) file in the example [ble_mesh_node](./ble_mesh_node/).
+
+## ble_mesh_provisioner
+
+This example shows how ESP32 acts as a BLE Mesh Provisioner and provisions other unprovisioned devices.
+
+See the [README.md](./ble_mesh_provisioner/README.md) file in the example [ble_mesh_provisioner](./ble_mesh_provisioner/).
+
+## ble_mesh_wifi_coexist
+
+This example shows how ESP32 acts as a BLE Mesh Fast Provisioning Server and coexists with Wi-Fi iperf functionality.
+
+See the [README.md](./ble_mesh_wifi_coexist/README.md) file in the example [ble_mesh_wifi_coexist](./ble_mesh_wifi_coexist/).
+
+# More
+
+See the [README.md](../../README.md) file in the upper level [examples](../../) directory for more information about examples.
+

diff --git a/examples/bluetooth/esp_ble_mesh/ble_mesh_fast_provision/ble_mesh_fast_prov_client/README.md b/examples/bluetooth/esp_ble_mesh/ble_mesh_fast_provision/ble_mesh_fast_prov_client/README.md
index 9e45f4f31b7d81d4d1fda1a877d42b9d956047f8..d49238e9743272d885454de3d71bbbb29627d1e3 100644 (file)
--- a/examples/bluetooth/esp_ble_mesh/ble_mesh_fast_provision/ble_mesh_fast_prov_client/README.md
+++ b/examples/bluetooth/esp_ble_mesh/ble_mesh_fast_provision/ble_mesh_fast_prov_client/README.md
@@ -1,2 +1,6 @@
-ESP BLE Mesh Fast Provisioning Client Demo
-========================
\ No newline at end of file
+ESP BLE Mesh Fast Provisioning Client example
+========================
+
+This example shows how a BLE Mesh device functions as a Fast Provisioning Client.
+
+Please check the [tutorial](tutorial/ble_mesh_fast_provision_client.md) for more information about this example.
\ No newline at end of file

diff --git a/examples/bluetooth/esp_ble_mesh/ble_mesh_fast_provision/ble_mesh_fast_prov_server/README.md b/examples/bluetooth/esp_ble_mesh/ble_mesh_fast_provision/ble_mesh_fast_prov_server/README.md
index 2746ed629aaa5e2e98e83ffb38bc2d6c5078d898..e12c5d3fb4e24f819962702e78901871c5d2f6ce 100644 (file)
--- a/examples/bluetooth/esp_ble_mesh/ble_mesh_fast_provision/ble_mesh_fast_prov_server/README.md
+++ b/examples/bluetooth/esp_ble_mesh/ble_mesh_fast_provision/ble_mesh_fast_prov_server/README.md
@@ -1,2 +1,6 @@
-ESP BLE Mesh Fast Provisioning Server Demo
-========================
\ No newline at end of file
+ESP BLE Mesh Fast Provisioning Server example
+========================
+
+This example shows how a BLE Mesh device functions as a Fast Provisioning Server.
+
+Please check the [tutorial](tutorial/ble_mesh_fast_provision_server.md) for more information about this example.
\ No newline at end of file