From 55982fa1463a7a4f53eb73ea75eb0ea5e00cf287 Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Tue, 7 Jul 2020 10:26:08 +0800 Subject: [PATCH] Rewrite Bluedroid BT READMEs from .rst to .md --- .../bt_discovery/{README.rst => README.md} | 15 +++++++------- .../classic_bt/bt_spp_acceptor/README.md | 19 ++++++++++++++++++ .../classic_bt/bt_spp_acceptor/README.rst | 20 ------------------- .../classic_bt/bt_spp_initiator/README.md | 20 +++++++++++++++++++ .../classic_bt/bt_spp_initiator/README.rst | 20 ------------------- .../classic_bt/bt_spp_vfs_acceptor/README.md | 17 ++++++++++++++++ .../classic_bt/bt_spp_vfs_acceptor/README.rst | 18 ----------------- .../classic_bt/bt_spp_vfs_initiator/README.md | 17 ++++++++++++++++ .../bt_spp_vfs_initiator/README.rst | 18 ----------------- 9 files changed, 80 insertions(+), 84 deletions(-) rename examples/bluetooth/bluedroid/classic_bt/bt_discovery/{README.rst => README.md} (59%) create mode 100644 examples/bluetooth/bluedroid/classic_bt/bt_spp_acceptor/README.md delete mode 100644 examples/bluetooth/bluedroid/classic_bt/bt_spp_acceptor/README.rst create mode 100644 examples/bluetooth/bluedroid/classic_bt/bt_spp_initiator/README.md delete mode 100644 examples/bluetooth/bluedroid/classic_bt/bt_spp_initiator/README.rst create mode 100644 examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_acceptor/README.md delete mode 100644 examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_acceptor/README.rst create mode 100644 examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_initiator/README.md delete mode 100644 examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_initiator/README.rst diff --git a/examples/bluetooth/bluedroid/classic_bt/bt_discovery/README.rst b/examples/bluetooth/bluedroid/classic_bt/bt_discovery/README.md similarity index 59% rename from examples/bluetooth/bluedroid/classic_bt/bt_discovery/README.rst rename to examples/bluetooth/bluedroid/classic_bt/bt_discovery/README.md index 8c5e1f0cb0..ff3a9cb67d 100644 --- a/examples/bluetooth/bluedroid/classic_bt/bt_discovery/README.rst +++ b/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. diff --git a/examples/bluetooth/bluedroid/classic_bt/bt_spp_acceptor/README.md b/examples/bluetooth/bluedroid/classic_bt/bt_spp_acceptor/README.md new file mode 100644 index 0000000000..da84639565 --- /dev/null +++ b/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. diff --git a/examples/bluetooth/bluedroid/classic_bt/bt_spp_acceptor/README.rst b/examples/bluetooth/bluedroid/classic_bt/bt_spp_acceptor/README.rst deleted file mode 100644 index 4fbc883033..0000000000 --- a/examples/bluetooth/bluedroid/classic_bt/bt_spp_acceptor/README.rst +++ /dev/null @@ -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. diff --git a/examples/bluetooth/bluedroid/classic_bt/bt_spp_initiator/README.md b/examples/bluetooth/bluedroid/classic_bt/bt_spp_initiator/README.md new file mode 100644 index 0000000000..9088c1cec1 --- /dev/null +++ b/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. diff --git a/examples/bluetooth/bluedroid/classic_bt/bt_spp_initiator/README.rst b/examples/bluetooth/bluedroid/classic_bt/bt_spp_initiator/README.rst deleted file mode 100644 index 543f43faec..0000000000 --- a/examples/bluetooth/bluedroid/classic_bt/bt_spp_initiator/README.rst +++ /dev/null @@ -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. diff --git a/examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_acceptor/README.md b/examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_acceptor/README.md new file mode 100644 index 0000000000..290015264b --- /dev/null +++ b/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. diff --git a/examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_acceptor/README.rst b/examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_acceptor/README.rst deleted file mode 100644 index f4ecf95d33..0000000000 --- a/examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_acceptor/README.rst +++ /dev/null @@ -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. diff --git a/examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_initiator/README.md b/examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_initiator/README.md new file mode 100644 index 0000000000..374a9344f3 --- /dev/null +++ b/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. diff --git a/examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_initiator/README.rst b/examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_initiator/README.rst deleted file mode 100644 index 4f2f0eb4c6..0000000000 --- a/examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_initiator/README.rst +++ /dev/null @@ -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.