examples: change default build instructions in docs to CMake

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

View File

@@ -6,7 +6,7 @@ Simple Asio chat client using WiFi STA or Ethernet.
- Wi-Fi or Ethernet connection is established, and IP address is obtained.
- Asio chat client connects to the corresponding server whose port number and IP are defined through the project configuration menu.
- Chat client receives all messages from other chat clients, also it sends message received from stdin using `idf.py monitor`.
- Chat client receives all messages from other chat clients, also it sends message received from stdin using `idf.py -p PORT monitor`.
## Running the example

View File

@@ -16,7 +16,7 @@ please refer to [RFC7252](https://www.rfc-editor.org/rfc/pdfrfc/rfc7252.txt.pdf)
### Configure the project
```
make menuconfig
idf.py menuconfig
```
* Set serial port under Serial Flasher config
@@ -29,7 +29,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-]``.)

View File

@@ -16,7 +16,7 @@ please refer to [RFC7252](https://www.rfc-editor.org/rfc/pdfrfc/rfc7252.txt.pdf)
### Configure the project
```
make menuconfig
idf.py menuconfig
```
* Set default serial port under Serial Flasher config
@@ -28,7 +28,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-]``.)

View File

@@ -4,7 +4,7 @@ This example creates a `esp_local_ctrl` service over HTTPS transport, for secure
See the `esp_local_ctrl` component documentation for details.
Before using the example, run `make menuconfig` (or `idf.py menuconfig` if using CMake build system) to configure Wi-Fi or Ethernet. See "Establishing Wi-Fi or Ethernet Connection" section in [examples/protocols/README.md](../README.md) for more details.
Before using the example, run `idf.py menuconfig` (or `idf.py menuconfig` if using CMake build system) to configure Wi-Fi or Ethernet. See "Establishing Wi-Fi or Ethernet Connection" section in [examples/protocols/README.md](../README.md) for more details.
## Client Side Implementation

View File

@@ -20,7 +20,7 @@
#include "lwip/err.h"
#include "lwip/sys.h"
/* The examples use WiFi configuration that you can set via 'make menuconfig'.
/* The examples use WiFi configuration that you can set via 'idf.py menuconfig'.
If you'd rather not, just change the below entries to strings with
the config you want - ie #define EXAMPLE_WIFI_SSID "mywifissid"

View File

@@ -27,7 +27,7 @@ File server implementation can be found under `main/file_server.c` which uses SP
* In order to test the file server demo :
1. compile and burn the firmware `idf.py -p PORT flash`
2. run `idf.py monitor` and note down the IP assigned to your ESP module. The default port is 80
2. run `idf.py -p PORT monitor` and note down the IP assigned to your ESP module. The default port is 80
3. test the example interactively on a web browser (assuming IP is 192.168.43.130):
1. open path `http://192.168.43.130/` or `http://192.168.43.130/index.html` to see an HTML web page with list of files on the server (initially empty)
2. use the file upload form on the webpage to select and upload a file to the server

View File

@@ -24,7 +24,7 @@ Shows how to use mDNS to advertise lookup services and hosts
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
```
- Wait for WiFi to connect to your access point

View File

@@ -72,7 +72,7 @@ ESP32 WROVER KIT 1 | | RS-485 side | | Exter
### Configure the application
Configure the UART pins used for modbus communication using command and table below.
```
make menuconfig
idf.py menuconfig
```
```
@@ -98,7 +98,7 @@ Other option is to have the modbus_slave example flashed into ESP32 WROVER KIT b
### Build and flash software of master device
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-]``.)

View File

@@ -30,7 +30,7 @@ ESP32 WROVER KIT 1 | | RS-485 side | | Modbus
### Configure the application
Configure the UART pins used for modbus communication using command and table below.
```
make menuconfig
idf.py menuconfig
```
```
@@ -53,7 +53,7 @@ As an example the Modbus Poll application can be used with this example.
### Build and flash software
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-]``.)

View File

@@ -33,7 +33,7 @@ This example can be executed on any ESP32 board, the only required interface is
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-]``.)

View File

@@ -33,7 +33,7 @@ with text operation.
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-]``.)

View File

@@ -43,7 +43,7 @@ Please note, that the supplied files `client.crt` and `client.key` in the `main`
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-]``.)

View File

@@ -1,7 +1,7 @@
# ESP-MQTT sample application
(See the README.md file in the upper level 'examples' directory for more information about examples.)
This example connects to the broker URI selected using `make menuconfig` (using mqtt tcp transport) and as a demonstration subscribes/unsubscribes and send a message on certain topic.
This example connects to the broker URI selected using `idf.py menuconfig` (using mqtt tcp transport) and as a demonstration subscribes/unsubscribes and send a message on certain topic.
(Please note that the public broker is maintained by the community so may not be always available, for details please see this [disclaimer](https://iot.eclipse.org/getting-started/#sandboxes))
Note: If the URI equals `FROM_STDIN` then the broker address is read from stdin upon application startup (used for testing)
@@ -25,7 +25,7 @@ This example can be executed on any ESP32 board, the only required interface is
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-]``.)

View File

@@ -24,7 +24,7 @@ This example can be executed on any ESP32 board, the only required interface is
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-]``.)

View File

@@ -34,7 +34,7 @@ with text operation.
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-]``.)

View File

@@ -79,7 +79,7 @@ This example can be run on any commonly available ESP32 development board.
## Configure the project
```
make menuconfig
idf.py menuconfig
```
* Set serial port under Serial Flasher Options.
@@ -91,7 +91,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-]``.)

View File

@@ -35,7 +35,7 @@ This example can be run on any commonly available ESP32 development board.
## Configure the project
```
make menuconfig
idf.py menuconfig
```
Set following parameter under Serial Flasher Options:
@@ -59,7 +59,7 @@ Configure Wi-Fi or Ethernet under "Example Connection Configuration" menu. See "
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-]``.)

View File

@@ -37,7 +37,7 @@ This example can be run on any commonly available ESP32 development board.
## Configure the project
```
make menuconfig
idf.py menuconfig
```
Set following parameter under Serial Flasher Options:
@@ -57,7 +57,7 @@ Configure Wi-Fi or Ethernet under "Example Connection Configuration" menu. See "
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-]``.)

View File

@@ -45,7 +45,7 @@ This example can be run on any commonly available ESP32 development board.
## Configure the project
```
make menuconfig
idf.py menuconfig
```
Set following parameter under Serial Flasher Options:
@@ -70,7 +70,7 @@ Configure Wi-Fi or Ethernet under "Example Connection Configuration" menu. See "
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-]``.)

View File

@@ -47,7 +47,7 @@ This example can be run on any commonly available ESP32 development board.
## Configure the project
```
make menuconfig
idf.py menuconfig
```
Set following parameter under Serial Flasher Options:
@@ -67,7 +67,7 @@ Configure Wi-Fi or Ethernet under "Example Connection Configuration" menu. See "
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-]``.)