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

6
examples/peripherals/adc/README.md
View File

@@ -16,7 +16,7 @@ In this example, we use `ADC_UNIT_1` by default, we need to connect a voltage so
### Configure the project
```
make menuconfig
idf.py menuconfig
```
* Set serial port under Serial Flasher Options.
@@ -26,7 +26,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-]``.)
@@ -48,7 +48,7 @@ Raw: 18 Voltage: 79mV
* program upload failure
* Hardware connection is not correct: run `idf.py monitor`, and reboot your board to see if there are any output logs.
* Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs.
* The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
For any technical queries, please open an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.

6
examples/peripherals/adc2/README.md
View File

@@ -16,7 +16,7 @@ We use ADC1_CHANNEL_7 (GPIO27) and DAC_CHANNEL_1 (GPIO25) by default, you need t
### Configure the project
```
make menuconfig
idf.py menuconfig
```
* Set serial port under Serial Flasher Options.
@@ -27,7 +27,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-]``.)
@@ -59,7 +59,7 @@ start conversion.
* program upload failure
* Hardware connection is not correct: run `idf.py monitor`, and reboot your board to see if there are any output logs.
* Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs.
* The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
For any technical queries, please open an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.

6
examples/peripherals/i2s/README.md
View File

@@ -14,7 +14,7 @@ In this example, we generate a 100Hz triangle and sine wave and send it out from
### Configure the Project
```
make menuconfig
idf.py menuconfig
```
* Set serial port under Serial Flasher Options.
@@ -24,7 +24,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-]``.)
@@ -61,7 +61,7 @@ If you have a logic analyzer, you can use a logic analyzer to grab online data.
* Program upload failure
* Hardware connection is not correct: run `idf.py monitor`, and reboot your board to see if there are any output logs.
* Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs.
* The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
For any technical queries, please open an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.

6
examples/peripherals/i2s_adc_dac/README.md
View File

@@ -35,7 +35,7 @@ The following is the hardware connection:
### Configure the Project
```
make menuconfig
idf.py menuconfig
```
* Set serial port under Serial Flasher Options, the flash size should be set to 4 MB.
@@ -48,7 +48,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-]``.)
@@ -85,7 +85,7 @@ I2S: PLL_D2: Req RATE: 16000, real rate: 1004.000, BITS: 16, CLKM: 83, BCK: 60,
* Program upload failure
* Hardware connection is not correct: run `idf.py monitor`, and reboot your board to see if there are any output logs.
* Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs.
* The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
For any technical queries, please open an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.

6
examples/peripherals/ledc/README.md
View File

@@ -23,7 +23,7 @@ Connect four LEDs to the following LEDC channels / individual GPIOs:
### 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-]``.)
@@ -63,7 +63,7 @@ you can also see the following output log on the serial monitor:
* Programming fail
* Hardware connection is not correct: run `idf.py monitor`, and reboot your board to see if there are any output logs.
* Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs.
* The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
For any technical queries, please open an [issue] (https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.

6
examples/peripherals/pcnt/README.md
View File

@@ -20,7 +20,7 @@ Pin connection:
### Configure the project
```
make menuconfig
idf.py menuconfig
```
* Set serial port under Serial Flasher Options.
@@ -30,7 +30,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-]``.)
@@ -68,7 +68,7 @@ Current counter value :-1
* program upload failure
* Hardware connection is not correct: run `idf.py monitor`, and reboot your board to see if there are any output logs.
* Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs.
* The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
For any technical queries, please open an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.

6
examples/peripherals/rmt_nec_tx_rx/README.md
View File

@@ -25,7 +25,7 @@ The TX pin and RX pin can be modified in top of the main/infrared_nec_main.c fil
### Configure the Project
```
make menuconfig
idf.py menuconfig
```
* Set serial port under Serial Flasher Options.
@@ -35,7 +35,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-]``.)
@@ -74,7 +74,7 @@ NEC: RMT RCV --- addr: 0xda25 cmd: 0xeb14
* Programming fail
* Hardware connection is not correct: run `idf.py monitor`, and reboot your board to see if there is any output logs.
* Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there is any output logs.
* The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
For any technical queries, please open an [issue] (https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.

6
examples/peripherals/rmt_tx/README.md
View File

@@ -30,7 +30,7 @@ GPIO18 +----/\/\/\----+------|>|-----+ GND
### Configure the Project
```
make menuconfig
idf.py menuconfig
```
* Set serial port under Serial Flasher Options.
@@ -40,7 +40,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-]``.)
@@ -61,7 +61,7 @@ RMT Tx: Sample transmission complete
* Programming fail
* Hardware connection is not correct: run `idf.py monitor`, and reboot your board to see if there is any output logs.
* Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there is any output logs.
* The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
For any technical queries, please open an [issue] (https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.

4
examples/peripherals/sigmadelta/README.md
View File

@@ -24,7 +24,7 @@ By default the GPIO output is 4. To change it, edit the line with `GPIO_NUM_4` i
### Configure the project
```
make menuconfig
idf.py menuconfig
```
Set serial port under Serial Flasher Options and save the configuration.
@@ -35,7 +35,7 @@ Set serial port under Serial Flasher Options and save the configuration.
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-]``.)

6
examples/peripherals/uart/uart_async_rxtxtasks/README.md
View File

@@ -24,7 +24,7 @@ order to receive back the same data which were sent out.
### Configure the project
```
make menuconfig
idf.py menuconfig
```
or
```
@@ -38,11 +38,11 @@ idf.py 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
```
or
```
idf.py flash monitor
idf.py -p PORT flash monitor
```
(To exit the serial monitor, type ``Ctrl-]``.)

6
examples/peripherals/uart/uart_echo/README.md
View File

@@ -36,7 +36,7 @@ UART1 driver to use the hardware flow control by setting `.flow_ctrl = UART_HW_F
### Configure the project
```
make menuconfig
idf.py menuconfig
```
or
```
@@ -50,11 +50,11 @@ idf.py 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
```
or
```
idf.py flash monitor
idf.py -p PORT flash monitor
```
(To exit the serial monitor, type ``Ctrl-]``.)

6
examples/peripherals/uart/uart_echo_rs485/README.md
View File

@@ -45,7 +45,7 @@ Connect USB to RS485 adapter to computer and connect its D+, D- output lines wit
### Configure the project
```
make menuconfig
idf.py menuconfig
```
or
```
@@ -56,11 +56,11 @@ idf.py menuconfig
### Build and Flash
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
```
or
```
idf.py flash monitor
idf.py -p PORT flash monitor
```
(To exit the serial monitor, type ``Ctrl-]``.)

6
examples/peripherals/uart/uart_events/README.md
View File

@@ -14,7 +14,7 @@ The example can be used with any ESP32 development board connected to a computer
### Configure the project
```
make menuconfig
idf.py menuconfig
```
or
```
@@ -28,11 +28,11 @@ idf.py 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
```
or
```
idf.py flash monitor
idf.py -p PORT flash monitor
```
(To exit the serial monitor, type ``Ctrl-]``.)

6
examples/peripherals/uart/uart_select/README.md
View File

@@ -26,7 +26,7 @@ through UART.
### Configure the project
```
make menuconfig
idf.py menuconfig
```
or
```
@@ -40,11 +40,11 @@ idf.py 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
```
or
```
idf.py flash monitor
idf.py -p PORT flash monitor
```
(To exit the serial monitor, type ``Ctrl-]``.)