diff --git a/examples/bluetooth/a2dp_sink/README.rst b/examples/bluetooth/a2dp_sink/README.md similarity index 100% rename from examples/bluetooth/a2dp_sink/README.rst rename to examples/bluetooth/a2dp_sink/README.md diff --git a/examples/bluetooth/ble_adv/README.rst b/examples/bluetooth/ble_adv/README.md similarity index 100% rename from examples/bluetooth/ble_adv/README.rst rename to examples/bluetooth/ble_adv/README.md diff --git a/examples/bluetooth/ble_eddystone/README.rst b/examples/bluetooth/ble_eddystone/README.md similarity index 100% rename from examples/bluetooth/ble_eddystone/README.rst rename to examples/bluetooth/ble_eddystone/README.md diff --git a/examples/bluetooth/ble_ibeacon/README.rst b/examples/bluetooth/ble_ibeacon/README.md similarity index 100% rename from examples/bluetooth/ble_ibeacon/README.rst rename to examples/bluetooth/ble_ibeacon/README.md diff --git a/examples/bluetooth/ble_spp_client/README.rst b/examples/bluetooth/ble_spp_client/README.md similarity index 100% rename from examples/bluetooth/ble_spp_client/README.rst rename to examples/bluetooth/ble_spp_client/README.md diff --git a/examples/bluetooth/ble_spp_server/README.rst b/examples/bluetooth/ble_spp_server/README.md similarity index 100% rename from examples/bluetooth/ble_spp_server/README.rst rename to examples/bluetooth/ble_spp_server/README.md diff --git a/examples/bluetooth/blufi/README.rst b/examples/bluetooth/blufi/README.md similarity index 100% rename from examples/bluetooth/blufi/README.rst rename to examples/bluetooth/blufi/README.md diff --git a/examples/bluetooth/controller_hci_uart/README.rst b/examples/bluetooth/controller_hci_uart/README.md similarity index 100% rename from examples/bluetooth/controller_hci_uart/README.rst rename to examples/bluetooth/controller_hci_uart/README.md diff --git a/examples/bluetooth/gatt_client/README.rst b/examples/bluetooth/gatt_client/README.md similarity index 73% rename from examples/bluetooth/gatt_client/README.rst rename to examples/bluetooth/gatt_client/README.md index 6fd3febba..847c1bb64 100644 --- a/examples/bluetooth/gatt_client/README.rst +++ b/examples/bluetooth/gatt_client/README.md @@ -6,4 +6,4 @@ Run the gatt_server demo, the client demo will automatically connect to the gatt Client demo will enable gatt_server's notify after connection. Then the two devices will exchange data. - +Please check the [tutorial](tutorial/gatt_client_example_walkthrough.md) for more information about this example. diff --git a/examples/bluetooth/gatt_security_client/README.rst b/examples/bluetooth/gatt_security_client/README.md similarity index 83% rename from examples/bluetooth/gatt_security_client/README.rst rename to examples/bluetooth/gatt_security_client/README.md index 906f756bf..92c2132ea 100644 --- a/examples/bluetooth/gatt_security_client/README.rst +++ b/examples/bluetooth/gatt_security_client/README.md @@ -6,3 +6,4 @@ This is the demo for user to use ESP BLE security API to connection with peer de 2.Used the esp_ble_set_encryption API to start encryption with peer device, if the peer device take the initiative encryption, should used the esp_ble_gap_security_rsp API to sent response to peer device when receive the ESP_GAP_BLE_SEC_REQ_EVT. 3.It will receive the ESP_GAP_BLE_AUTH_CMPL_EVT event when encryption finish will peer device. +Please check the [tutorial](tutorial/GATT_Security_Client_Example_Walkthrough.md) for more information about this example. diff --git a/examples/bluetooth/gatt_security_server/README.rst b/examples/bluetooth/gatt_security_server/README.md similarity index 83% rename from examples/bluetooth/gatt_security_server/README.rst rename to examples/bluetooth/gatt_security_server/README.md index 56dc9ac02..5e3958350 100644 --- a/examples/bluetooth/gatt_security_server/README.rst +++ b/examples/bluetooth/gatt_security_server/README.md @@ -6,4 +6,5 @@ This is the demo for user to use ESP BLE security API to connection with peer de 2.Used the esp_ble_set_encryption API to start encryption with peer device, if the peer device take the initiative encryption, should used the esp_ble_gap_security_rsp API to sent response to peer device when receive the ESP_GAP_BLE_SEC_REQ_EVT. 3.It will receive the ESP_GAP_BLE_AUTH_CMPL_EVT event when encryption finish will peer device. +Please check the [tutorial](tutorial/GATT_SECURITY_SERVER_EXAMPLE_WALKTHROUGH.md) for more information about this example. diff --git a/examples/bluetooth/gatt_server/README.rst b/examples/bluetooth/gatt_server/README.md similarity index 75% rename from examples/bluetooth/gatt_server/README.rst rename to examples/bluetooth/gatt_server/README.md index a4fa38d0a..3df4ecb79 100644 --- a/examples/bluetooth/gatt_server/README.rst +++ b/examples/bluetooth/gatt_server/README.md @@ -6,3 +6,5 @@ be connected by client. Run the gatt_client demo, the client demo will automatic to the gatt_server demo. The client demo will enable gatt_server's notify after connection. Then the two devices will exchange data. +Please check the [tutorial] (./tutorial/GATT_SERVER_EXAMPLE_WALKTHROUGH.md) for more information about this example. + diff --git a/examples/bluetooth/gatt_server_service_table/README.rst b/examples/bluetooth/gatt_server_service_table/README.md similarity index 82% rename from examples/bluetooth/gatt_server_service_table/README.rst rename to examples/bluetooth/gatt_server_service_table/README.md index 7a763998d..313ecb773 100644 --- a/examples/bluetooth/gatt_server_service_table/README.rst +++ b/examples/bluetooth/gatt_server_service_table/README.md @@ -8,3 +8,4 @@ One is use the esp_gatts_create_service or esp_ble_gatts_add_char and etc. The other way is use esp_ble_gatts_create_attr_tab. The important things: the two ways cannot use in the same service, but can use in different service. +Please check the [tutorial](tutorial/GATT_Server_Service_Table_Example_Walkthrough.md) for more information about this example. diff --git a/examples/bluetooth/gattc_multi_connect/README.rst b/examples/bluetooth/gattc_multi_connect/README.md similarity index 81% rename from examples/bluetooth/gattc_multi_connect/README.rst rename to examples/bluetooth/gattc_multi_connect/README.md index 78d6956b2..c22436a4d 100644 --- a/examples/bluetooth/gattc_multi_connect/README.rst +++ b/examples/bluetooth/gattc_multi_connect/README.md @@ -7,3 +7,4 @@ Modify the name of gatt_server demo named ESP_GATTS_DEMO_a, ESP_GATTS_DEMO_b and the gattc_multi_connect demo will connect the three gatt_server demos, and then exchange data. Of course you can also modify the code to connect more devices, we default to connect up to 4 devices, more than 4 you need to modify menuconfig. +Please check the [tutorial](tutorial/GATT_Client_Multi-Connection_Example_Walkthrough.md) for more information about this example.