]> granicus.if.org Git - esp-idf/commitdiff
component/bt: add link of tutorial in README.rst
authorisland <island@espressif.com>
Wed, 29 Nov 2017 07:40:55 +0000 (15:40 +0800)
committerisland <island@espressif.com>
Wed, 3 Jan 2018 03:45:18 +0000 (11:45 +0800)
14 files changed:
examples/bluetooth/a2dp_sink/README.md [moved from examples/bluetooth/a2dp_sink/README.rst with 100% similarity]
examples/bluetooth/ble_adv/README.md [moved from examples/bluetooth/ble_adv/README.rst with 100% similarity]
examples/bluetooth/ble_eddystone/README.md [moved from examples/bluetooth/ble_eddystone/README.rst with 100% similarity]
examples/bluetooth/ble_ibeacon/README.md [moved from examples/bluetooth/ble_ibeacon/README.rst with 100% similarity]
examples/bluetooth/ble_spp_client/README.md [moved from examples/bluetooth/ble_spp_client/README.rst with 100% similarity]
examples/bluetooth/ble_spp_server/README.md [moved from examples/bluetooth/ble_spp_server/README.rst with 100% similarity]
examples/bluetooth/blufi/README.md [moved from examples/bluetooth/blufi/README.rst with 100% similarity]
examples/bluetooth/controller_hci_uart/README.md [moved from examples/bluetooth/controller_hci_uart/README.rst with 100% similarity]
examples/bluetooth/gatt_client/README.md [moved from examples/bluetooth/gatt_client/README.rst with 73% similarity]
examples/bluetooth/gatt_security_client/README.md [moved from examples/bluetooth/gatt_security_client/README.rst with 83% similarity]
examples/bluetooth/gatt_security_server/README.md [moved from examples/bluetooth/gatt_security_server/README.rst with 83% similarity]
examples/bluetooth/gatt_server/README.md [moved from examples/bluetooth/gatt_server/README.rst with 75% similarity]
examples/bluetooth/gatt_server_service_table/README.md [moved from examples/bluetooth/gatt_server_service_table/README.rst with 82% similarity]
examples/bluetooth/gattc_multi_connect/README.md [moved from examples/bluetooth/gattc_multi_connect/README.rst with 81% similarity]

similarity index 73%
rename from examples/bluetooth/gatt_client/README.rst
rename to examples/bluetooth/gatt_client/README.md
index 6fd3febba58049c36ba2b831192fdb22fd2a8036..847c1bb6430abd85aabd41a7a0b29ae691da92e6 100644 (file)
@@ -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.
similarity index 83%
rename from examples/bluetooth/gatt_security_client/README.rst
rename to examples/bluetooth/gatt_security_client/README.md
index 906f756bf9864cccf0dd2f69937c2afb15065a9e..92c2132ea61d247710e201642c6dd30eb103db68 100644 (file)
@@ -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.
similarity index 83%
rename from examples/bluetooth/gatt_security_server/README.rst
rename to examples/bluetooth/gatt_security_server/README.md
index 56dc9ac0284d1334e75e568d1d9711338c560de8..5e39583500077841aea101bc6d1ae572bad84be6 100644 (file)
@@ -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.
 
similarity index 75%
rename from examples/bluetooth/gatt_server/README.rst
rename to examples/bluetooth/gatt_server/README.md
index a4fa38d0aa8e9f878461fd133d8a064a05844751..3df4ecb795d32aaca64cc1fe264ab0f2626a339e 100644 (file)
@@ -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.
+
similarity index 82%
rename from examples/bluetooth/gatt_server_service_table/README.rst
rename to examples/bluetooth/gatt_server_service_table/README.md
index 7a763998d74d770e06512f5176bf232d2a8460f6..313ecb77398dc9beacbd32e674d42c2d6ad66eeb 100644 (file)
@@ -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.
similarity index 81%
rename from examples/bluetooth/gattc_multi_connect/README.rst
rename to examples/bluetooth/gattc_multi_connect/README.md
index 78d6956b26874dcf456a15c99c9c6442d945f3aa..c22436a4ddb2088210d3f4a9f1fc946764611f66 100644 (file)
@@ -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.