eaw/esp-idf
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

examples: change default build instructions in docs to CMake

Browse Source
This commit is contained in:
Mahavir Jain
2019-08-02 09:01:20 +05:30
parent 76191a0f55
commit 70af759dd2
63 changed files with 136 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
examples/bluetooth/bluedroid/ble/ble_spp_client/README.md
View File

@@ -81,7 +81,7 @@
Build each project and flash it to the board, then run monitor tool to view serial output:
```
make -j4 flash monitor
idf.py -p PORT flash monitor
```
(To exit the serial monitor, type ``Ctrl-]``.)

2
examples/bluetooth/bluedroid/classic_bt/a2dp_sink/README.md
View File

@@ -40,7 +40,7 @@ idf.py menuconfig
Build the project and flash it to the board, then run monitor tool to view serial output.
```
idf.py flash monitor
idf.py -p PORT flash monitor
```
(To exit the serial monitor, type ``Ctrl-]``.)

4
examples/bluetooth/esp_ble_mesh/ble_mesh_fast_provision/ble_mesh_fast_prov_server/tutorial/EspBleMesh.md
View File

@@ -16,7 +16,7 @@ A video of this demo can be seen
> 1. Please flash the [`ble_mesh_fast_prov_server`](https://glab.espressif.cn/ble_mesh/esp-ble-mesh-v0.6/tree/ble_mesh_release/esp-ble-mesh-v0.6/examples/bluetooth/esp_ble_mesh/ble_mesh_fast_provision/ble_mesh_fast_prov_server) to your boards first;
> 2. To have a better understanding of the performance of the BLE Mesh network, we recommend that at least 3 devices should be added in your network.
> 3. We recommend that you solder LED indicators if your development board does not come with lights.
> 4. Please check the type of board and LED pin definition enabled in `Example BLE Mesh Config` by running `make menuconfig`
> 4. Please check the type of board and LED pin definition enabled in `Example BLE Mesh Config` by running `idf.py menuconfig`
![Board](images/device.png)
@@ -30,7 +30,7 @@ examples/bluetooth/esp_ble_mesh/ble_mesh_fast_provision/ble_mesh_fast_prov_serve
![Checkenvironment](images/picture1.png)
4. Run `make -j4 flash` to compile codes and flash the codes to the device.
4. Run `idf.py -p PORT flash` to compile codes and flash the codes to the device.
![compiledcode](images/picture2.png)

4
examples/bluetooth/esp_ble_mesh/ble_mesh_node/README.md
View File

@@ -8,9 +8,9 @@ This demo shows how BLE Mesh device can be set up as a node with the following f
- **Configuration Server model**: The role of this model is mainly to configure Provisioner device’s AppKey and set up its relay function, TTL size, subscription, etc.
- **OnOff Server model**: This model implements the most basic function of turning the lights on and off.
The default purpose of this demo is to enable the advertising function with 20-ms non-connectable interval in BLE 5.0. You can disable this function through menuconfig: `make menuconfig --> Example Configuration --> This option facilitates sending with 20ms non-connectable interval...`
The default purpose of this demo is to enable the advertising function with 20-ms non-connectable interval in BLE 5.0. You can disable this function through menuconfig: `idf.py menuconfig --> Example Configuration --> This option facilitates sending with 20ms non-connectable interval...`
For a better demonstration effect, an RGB LED can be soldered onto the ESP32-DevKitC board, by connecting their corresponding GPIO pins are GPIO\_NUM\_25, GPIO\_NUM\_26, GPIO\_NUM\_27. Then you need to select the following option in menuconfig:
`make menuconfig --> Example Configuration --> Board selection for BLE Mesh --> ESP-WROOM-32`
`idf.py menuconfig --> Example Configuration --> Board selection for BLE Mesh --> ESP-WROOM-32`
Please check the [tutorial](tutorial/Ble_Mesh_Node_Example_Walkthrough.md) for more information about this example.

8
examples/bluetooth/esp_ble_mesh/ble_mesh_node/tutorial/Ble_Mesh_Node_Example_Walkthrough.md
View File

@@ -27,9 +27,9 @@ $ tree examples/bluetooth/esp_ble_mesh/ble_mesh/ble_mesh_node
├── README.md /* Quick start guide */
├── build
├── main /* Stores the `.c` and `.h` application code files for this demo */
├── sdkconfig /* Current parameters of `make menuconfig` */
├── sdkconfig.defaults /* Default parameters of `make menuconfig` */
├── sdkconfig.old /* Previously saved parameters of `make menuconfig` */
├── sdkconfig /* Current parameters of `idf.py menuconfig` */
├── sdkconfig.defaults /* Default parameters of `idf.py menuconfig` */
├── sdkconfig.old /* Previously saved parameters of `idf.py menuconfig` */
└── tutorial /* More in-depth information about the demo */
```
@@ -381,7 +381,7 @@ These variables should be set to `0` for this demo, as it uses the most basic au
To be functional across different applications, the BLE Mesh menuconfig is specifically designed to offer a variety of configuration options, which can be helpful in tailoring your own configuration.
The list of configuration options in BLE Mesh menuconfig is stored in `Component config` ---> `[]Bluetooth Mesh support` and can be accessed with the command `make menuconfig`. This configuration option list is shown below.
The list of configuration options in BLE Mesh menuconfig is stored in `Component config` ---> `[]Bluetooth Mesh support` and can be accessed with the command `idf.py menuconfig`. This configuration option list is shown below.
```
—— Bluetooth Mesh support

6
examples/bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist/tutorial/ble_mesh_wifi_coexist.md
View File

@@ -40,9 +40,9 @@ $ tree examples/bluetooth/esp_ble_mesh/ble_mesh/ble_mesh_wifi_coexist
├── Makefile /* Compiling parameters for the demo */
├── README.md /* Quick start guide */
├── build
├── sdkconfig /* Current parameters of `make menuconfig` */
├── sdkconfig.defaults /* Default parameters of `make menuconfig` */
├── sdkconfig.old /* Previously saved parameters of `make menuconfig` */
├── sdkconfig /* Current parameters of `idf.py menuconfig` */
├── sdkconfig.defaults /* Default parameters of `idf.py menuconfig` */
├── sdkconfig.old /* Previously saved parameters of `idf.py menuconfig` */
└── tutorial /* More in-depth information about the demo */
```

4
examples/bluetooth/nimble/blecent/README.md
View File

@@ -32,7 +32,7 @@ Note :
### Configure the project
```
make menuconfig
idf.py menuconfig
```
* Set serial port under Serial Flasher Options.
@@ -42,7 +42,7 @@ make menuconfig
Build the project and flash it to the board, then run monitor tool to view serial output:
```
make -j4 flash monitor
idf.py -p PORT flash monitor
```
(To exit the serial monitor, type ``Ctrl-]``.)

4
examples/bluetooth/nimble/blehr/README.md
View File

@@ -23,7 +23,7 @@ Note :
### Configure the project
```
make menuconfig
idf.py menuconfig
```
* Set serial port under Serial Flasher Options.
@@ -33,7 +33,7 @@ make menuconfig
Build the project and flash it to the board, then run monitor tool to view serial output:
```
make -j4 flash monitor
idf.py -p PORT flash monitor
```
(To exit the serial monitor, type ``Ctrl-]``.)

4
examples/bluetooth/nimble/blemesh/README.md
View File

@@ -20,7 +20,7 @@ To test this demo, any BLE mesh provisioner app can be used.
### Configure the project
```
make menuconfig
idf.py menuconfig
```
* Set serial port under Serial Flasher Options.
@@ -32,7 +32,7 @@ make menuconfig
Build the project and flash it to the board, then run monitor tool to view serial output:
```
make -j4 flash monitor
idf.py -p PORT flash monitor
```
(To exit the serial monitor, type ``Ctrl-]``.)

4
examples/bluetooth/nimble/bleprph/README.md
View File

@@ -24,7 +24,7 @@ Note :
### Configure the project
```
make menuconfig
idf.py menuconfig
```
* Set serial port under Serial Flasher Options.
@@ -38,7 +38,7 @@ make menuconfig
Build the project and flash it to the board, then run monitor tool to view serial output:
```
make -j4 flash monitor
idf.py -p PORT flash monitor
```
(To exit the serial monitor, type ``Ctrl-]``.)