Просмотр исходного кода

Rewrite Bluedroid BT READMEs from .rst to .md

Marius Vikhammer 5 лет назад
Родитель
Сommit
55982fa146

+ 7 - 8
examples/bluetooth/bluedroid/classic_bt/bt_discovery/README.rst → examples/bluetooth/bluedroid/classic_bt/bt_discovery/README.md

@@ -1,6 +1,5 @@
-================= =====
-Supported Targets ESP32
-================= =====
+| Supported Targets | ESP32 |
+| ----------------- | ----- |
 
 ESP-IDF BT-INQUIRY demo
 ======================
@@ -9,10 +8,10 @@ Demo of Classic Bluetooth Device and Service Discovery
 
 This is the demo for user to use ESP_APIs to perform inquiry to search for a target device and then performs service search via SDP.
 
-Options choose step:
-    1. idf.py menuconfig.
-    2. enter menuconfig "Component config", choose "Bluetooth"
-    3. enter menu Bluetooth, choose "Classic Bluetooth" and do not choose "Release DRAM from Classic BT controller"
-    4. choose your options.
+Options choose step:`
+1. `idf.py menuconfig`
+2. enter menuconfig `Component config`, choose `Bluetooth`
+3. enter menu Bluetooth, choose `Classic Bluetooth` and do not choose `Release DRAM from Classic BT controller`
+4. choose your options.
 
 After the program started, the device will start inquiry to search for a device with Major device type "PHONE" in the Class of Device Field. Then it will cancel the inquiry and started to perform service discovering on this remote device.

+ 19 - 0
examples/bluetooth/bluedroid/classic_bt/bt_spp_acceptor/README.md

@@ -0,0 +1,19 @@
+| Supported Targets | ESP32 |
+| ----------------- | ----- |
+
+ESP-IDF BT-SPP-ACCEPTOR demo
+======================
+
+Demo of SPP acceptor role
+
+This is the demo for user to use ESP_APIs to create a SPP acceptor.
+
+Options choose step:
+1. `idf.py menuconfig`
+2. enter menuconfig `Component config`, choose `Bluetooth`
+3. enter menu Bluetooth, choose `Classic Bluetooth" and "SPP Profile`
+4. choose your options.
+
+Then set `SPP_SHOW_MODE` as `SPP_SHOW_DATA` or `SPP_SHOW_SPEED` in code(should be same with bt_spp_initator).
+
+After the program started, bt_spp_initator will connect it and send data.

+ 0 - 20
examples/bluetooth/bluedroid/classic_bt/bt_spp_acceptor/README.rst

@@ -1,20 +0,0 @@
-================= =====
-Supported Targets ESP32
-================= =====
-
-ESP-IDF BT-SPP-ACCEPTOR demo
-======================
-
-Demo of SPP acceptor role
-
-This is the demo for user to use ESP_APIs to create a SPP acceptor.
-
-Options choose step:
-    1. idf.py menuconfig.
-    2. enter menuconfig "Component config", choose "Bluetooth"
-    3. enter menu Bluetooth, choose "Classic Bluetooth" and "SPP Profile"
-    4. choose your options.
-
-Then set SPP_SHOW_MODE as SPP_SHOW_DATA or SPP_SHOW_SPEED in code(should be same with bt_spp_initator).
-
-After the program started, bt_spp_initator will connect it and send data.

+ 20 - 0
examples/bluetooth/bluedroid/classic_bt/bt_spp_initiator/README.md

@@ -0,0 +1,20 @@
+| Supported Targets | ESP32 |
+| ----------------- | ----- |
+
+
+ESP-IDF BT-SPP-INITATOR demo
+======================
+
+Demo of SPP initator role
+
+This is the demo for user to use ESP_APIs to create a SPP initator.
+
+Options choose step:
+1. `idf.py menuconfig`
+2. enter menuconfig `Component config`, choose `Bluetooth`
+3. enter menu Bluetooth, choose `Classic Bluetooth` and `SPP Profile`
+4. choose your options.
+
+Then set `SPP_SHOW_MODE` as `SPP_SHOW_DATA` or `SPP_SHOW_SPEED` in code(should be same with bt_spp_acceptor).
+
+After the program started, It will connect to bt_spp_acceptor and send data.

+ 0 - 20
examples/bluetooth/bluedroid/classic_bt/bt_spp_initiator/README.rst

@@ -1,20 +0,0 @@
-================= =====
-Supported Targets ESP32
-================= =====
-
-ESP-IDF BT-SPP-INITATOR demo
-======================
-
-Demo of SPP initator role
-
-This is the demo for user to use ESP_APIs to create a SPP initator.
-
-Options choose step:
-    1. idf.py menuconfig.
-    2. enter menuconfig "Component config", choose "Bluetooth"
-    3. enter menu Bluetooth, choose "Classic Bluetooth" and "SPP Profile"
-    4. choose your options.
-
-Then set SPP_SHOW_MODE as SPP_SHOW_DATA or SPP_SHOW_SPEED in code(should be same with bt_spp_acceptor).
-
-After the program started, It will connect to bt_spp_acceptor and send data.

+ 17 - 0
examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_acceptor/README.md

@@ -0,0 +1,17 @@
+| Supported Targets | ESP32 |
+| ----------------- | ----- |
+
+ESP-IDF BT-SPP-VFS-ACCEPTOR demo
+======================
+
+Demo of SPP acceptor role
+
+This is the demo for user to use ESP_APIs to create a SPP acceptor.
+
+Options choose step:
+1. `idf.py menuconfig`
+2. enter menuconfig `Component config`, choose `Bluetooth`
+3. enter menu Bluetooth, choose `Classic Bluetooth` and `SPP Profile`
+4. choose your options.
+
+After the program started, bt_spp_vfs_initator will connect it and send data.

+ 0 - 18
examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_acceptor/README.rst

@@ -1,18 +0,0 @@
-================= =====
-Supported Targets ESP32
-================= =====
-
-ESP-IDF BT-SPP-VFS-ACCEPTOR demo
-======================
-
-Demo of SPP acceptor role
-
-This is the demo for user to use ESP_APIs to create a SPP acceptor.
-
-Options choose step:
-    1. idf.py menuconfig.
-    2. enter menuconfig "Component config", choose "Bluetooth"
-    3. enter menu Bluetooth, choose "Classic Bluetooth" and "SPP Profile"
-    4. choose your options.
-
-After the program started, bt_spp_vfs_initator will connect it and send data.

+ 17 - 0
examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_initiator/README.md

@@ -0,0 +1,17 @@
+| Supported Targets | ESP32 |
+| ----------------- | ----- |
+
+ESP-IDF BT-SPP-VFS-INITATOR demo
+======================
+
+Demo of SPP initator role
+
+This is the demo for user to use ESP_APIs to create a SPP initator.
+
+Options choose step:
+1. `idf.py menuconfig`
+2. enter menuconfig `Component config`, choose `Bluetooth`
+3. enter menu Bluetooth, choose `Classic Bluetooth` and `SPP Profile`
+4. choose your options.
+
+After the program started, It will connect to bt_spp_vfs_acceptor and send data.

+ 0 - 18
examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_initiator/README.rst

@@ -1,18 +0,0 @@
-================= =====
-Supported Targets ESP32
-================= =====
-
-ESP-IDF BT-SPP-VFS-INITATOR demo
-======================
-
-Demo of SPP initator role
-
-This is the demo for user to use ESP_APIs to create a SPP initator.
-
-Options choose step:
-    1. idf.py menuconfig.
-    2. enter menuconfig "Component config", choose "Bluetooth"
-    3. enter menu Bluetooth, choose "Classic Bluetooth" and "SPP Profile"
-    4. choose your options.
-
-After the program started, It will connect to bt_spp_vfs_acceptor and send data.