Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge branch 'bugfix/uart_echo_readme_v4.1' into 'release/v4.1'

Browse source 
example: Remove duplicate commands and invalid serial port information (v4.1)

See merge request espressif/esp-idf!8335
This commit is contained in:
Krzysztof Budzynski 2020-04-14 00:33:50 +08:00
commit 5a09cfe70a
33 changed files with 6 additions and 115 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
examples/bluetooth/nimble/blecent/README.md
View file

@ -35,8 +35,6 @@ Note :
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
### Build and Flash ### Build and Flash
Build the project and flash it to the board, then run monitor tool to view serial output: Build the project and flash it to the board, then run monitor tool to view serial output:

2
examples/bluetooth/nimble/blehr/README.md
View file

@ -26,8 +26,6 @@ Note :
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
### Build and Flash ### Build and Flash
Build the project and flash it to the board, then run monitor tool to view serial output: Build the project and flash it to the board, then run monitor tool to view serial output:

2
examples/bluetooth/nimble/blemesh/README.md
View file

@ -23,8 +23,6 @@ To test this demo, any BLE mesh provisioner app can be used.
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
* Select 'Enable BLE mesh functionality' under 'Component config > Bluetooth > Enable NimBLE host stack'. * Select 'Enable BLE mesh functionality' under 'Component config > Bluetooth > Enable NimBLE host stack'.
### Build and Flash ### Build and Flash

2
examples/bluetooth/nimble/bleprph/README.md
View file

@ -29,8 +29,6 @@ Note :
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
* Select I/O capabilities of device from 'Example Configuration > I/O Capability', default is 'Just_works'. * Select I/O capabilities of device from 'Example Configuration > I/O Capability', default is 'Just_works'.
* Enable/Disable other security related parameters 'Bonding, MITM option, secure connection(SM SC)' from 'Example Configuration'. * Enable/Disable other security related parameters 'Bonding, MITM option, secure connection(SM SC)' from 'Example Configuration'.

2
examples/peripherals/adc/README.md
View file

@ -19,8 +19,6 @@ In this example, we use `ADC_UNIT_1` by default, we need to connect a voltage so
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
### Build and Flash ### Build and Flash
Build the project and flash it to the board, then run monitor tool to view serial output: Build the project and flash it to the board, then run monitor tool to view serial output:

2
examples/peripherals/adc2/README.md
View file

@ -27,8 +27,6 @@ We use ADC1_CHANNEL_7 (GPIO18) and DAC_CHANNEL_1 (GPIO17) by default, you need t
``` ```
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
* Set ADC2 and DAC channel in "Example Configuration" * Set ADC2 and DAC channel in "Example Configuration"
### Build and Flash ### Build and Flash

2
examples/peripherals/i2s/README.md
View file

@ -17,8 +17,6 @@ In this example, we generate a 100Hz triangle and sine wave and send it out from
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
### Build and Flash ### Build and Flash
Build the project and flash it to the board, then run monitor tool to view serial output: Build the project and flash it to the board, then run monitor tool to view serial output:

2
examples/peripherals/i2s_adc_dac/README.md
View file

@ -38,7 +38,7 @@ The following is the hardware connection:
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options, the flash size should be set to 4 MB. * Set the flash size to 4 MB under Serial Flasher Options.
* Select "Custom partition table CSV" and rename "Custom partition CSV file" to "partitions_adc_dac_example.csv". * Select "Custom partition table CSV" and rename "Custom partition CSV file" to "partitions_adc_dac_example.csv".
(Note that you can use `sdkconfig.defaults`) (Note that you can use `sdkconfig.defaults`)

2
examples/peripherals/ledc/README.md
View file

@ -26,8 +26,6 @@ Connect four LEDs to the following LEDC channels / individual GPIOs:
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
### Build and Flash ### Build and Flash
Build the project and flash it to the board, then run monitor tool to view serial output: Build the project and flash it to the board, then run monitor tool to view serial output:

2
examples/peripherals/pcnt/README.md
View file

@ -23,8 +23,6 @@ Pin connection:
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
### Build and Flash ### Build and Flash
Build the project and flash it to the board, then run monitor tool to view serial output: Build the project and flash it to the board, then run monitor tool to view serial output:

3
examples/peripherals/sigmadelta/README.md
View file

@ -27,9 +27,6 @@ By default the GPIO output is 4. To change it, edit the line with `GPIO_NUM_4` i
idf.py menuconfig idf.py menuconfig
``` ```
Set serial port under Serial Flasher Options and save the configuration.
### Build and Flash ### Build and Flash
Build the project and flash it to the board, then run monitor tool to view serial output: Build the project and flash it to the board, then run monitor tool to view serial output:

10
examples/peripherals/uart/uart_async_rxtxtasks/README.md
View file

@ -26,21 +26,11 @@ order to receive back the same data which were sent out.
``` ```
idf.py menuconfig idf.py menuconfig
``` ```
or
```
idf.py menuconfig
```
* Set serial port under Serial Flasher Options.
### Build and Flash ### Build and Flash
Build the project and flash it to the board, then run monitor tool to view serial output: Build the project and flash it to the board, then run monitor tool to view serial output:
```
idf.py -p PORT flash monitor
```
or
``` ```
idf.py -p PORT flash monitor idf.py -p PORT flash monitor
``` ```

10
examples/peripherals/uart/uart_echo/README.md
View file

@ -38,21 +38,11 @@ UART1 driver to use the hardware flow control by setting `.flow_ctrl = UART_HW_F
``` ```
idf.py menuconfig idf.py menuconfig
``` ```
or
```
idf.py menuconfig
```
* Set serial port under Serial Flasher Options.
### Build and Flash ### Build and Flash
Build the project and flash it to the board, then run monitor tool to view serial output: Build the project and flash it to the board, then run monitor tool to view serial output:
```
idf.py -p PORT flash monitor
```
or
``` ```
idf.py -p PORT flash monitor idf.py -p PORT flash monitor
``` ```

9
examples/peripherals/uart/uart_echo_rs485/README.md
View file

@ -47,21 +47,12 @@ Connect USB to RS485 adapter to computer and connect its D+, D- output lines wit
``` ```
idf.py menuconfig idf.py menuconfig
``` ```
or
```
idf.py menuconfig
```
* Set serial port under Serial Flasher Options to the serial port of ESP32-WROVER-KIT board.
### Build and Flash ### Build and Flash
Build the project and flash it to the board, then run monitor tool to view serial output: Build the project and flash it to the board, then run monitor tool to view serial output:
``` ```
idf.py -p PORT flash monitor idf.py -p PORT flash monitor
``` ```
or
```
idf.py -p PORT flash monitor
```
(To exit the serial monitor, type ``Ctrl-]``.) (To exit the serial monitor, type ``Ctrl-]``.)

10
examples/peripherals/uart/uart_events/README.md
View file

@ -16,21 +16,11 @@ The example can be used with any ESP32 development board connected to a computer
``` ```
idf.py menuconfig idf.py menuconfig
``` ```
or
```
idf.py menuconfig
```
* Set serial port under Serial Flasher Options.
### Build and Flash ### Build and Flash
Build the project and flash it to the board, then run monitor tool to view serial output: Build the project and flash it to the board, then run monitor tool to view serial output:
```
idf.py -p PORT flash monitor
```
or
``` ```
idf.py -p PORT flash monitor idf.py -p PORT flash monitor
``` ```

10
examples/peripherals/uart/uart_select/README.md
View file

@ -28,21 +28,11 @@ through UART.
``` ```
idf.py menuconfig idf.py menuconfig
``` ```
or
```
idf.py menuconfig
```
* Set serial port under Serial Flasher Options.
### Build and Flash ### Build and Flash
Build the project and flash it to the board, then run monitor tool to view serial output: Build the project and flash it to the board, then run monitor tool to view serial output:
```
idf.py -p PORT flash monitor
```
or
``` ```
idf.py -p PORT flash monitor idf.py -p PORT flash monitor
``` ```

2
examples/protocols/sockets/README.md
View file

@ -82,8 +82,6 @@ This example can be run on any commonly available ESP32 development board.
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
* Specific configuration for each example can be found in its README.md file. * Specific configuration for each example can be found in its README.md file.
## Build and Flash ## Build and Flash

4
examples/protocols/sockets/tcp_client/README.md
View file

@ -38,10 +38,6 @@ This example can be run on any commonly available ESP32 development board.
idf.py menuconfig idf.py menuconfig
``` ```
Set following parameter under Serial Flasher Options:
* Set `Default serial port`.
Set following parameters under Example Configuration Options: Set following parameters under Example Configuration Options:
* Set `IP version` of example to be IPV4 or IPV6. * Set `IP version` of example to be IPV4 or IPV6.

4
examples/protocols/sockets/tcp_server/README.md
View file

@ -40,10 +40,6 @@ This example can be run on any commonly available ESP32 development board.
idf.py menuconfig idf.py menuconfig
``` ```
Set following parameter under Serial Flasher Options:
* Set `Default serial port`.
Set following parameters under Example Configuration Options: Set following parameters under Example Configuration Options:
* Set `IP version` of the example to be IPV4 or IPV6. * Set `IP version` of the example to be IPV4 or IPV6.

4
examples/protocols/sockets/udp_client/README.md
View file

@ -48,10 +48,6 @@ This example can be run on any commonly available ESP32 development board.
idf.py menuconfig idf.py menuconfig
``` ```
Set following parameter under Serial Flasher Options:
* Set `Default serial port`.
Set following parameters under Example Configuration Options: Set following parameters under Example Configuration Options:
* Set `IP version` of example to be IPV4 or IPV6. * Set `IP version` of example to be IPV4 or IPV6.

4
examples/protocols/sockets/udp_server/README.md
View file

@ -50,10 +50,6 @@ This example can be run on any commonly available ESP32 development board.
idf.py menuconfig idf.py menuconfig
``` ```
Set following parameter under Serial Flasher Options:
* Set `Default serial port`.
Set following parameters under Example Configuration Options: Set following parameters under Example Configuration Options:
* Set `IP version` of the example to be IPV4 or IPV6. * Set `IP version` of the example to be IPV4 or IPV6.

2
examples/provisioning/ble_prov/README.md
View file

@ -50,8 +50,6 @@ There are various applications, specific to Windows and macOS platform which can
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
* Under Example Configuration set the following : * Under Example Configuration set the following :
* Security Version (default 1) * Security Version (default 1)
* Proof of Possession (default "abcd1234") * Proof of Possession (default "abcd1234")

2
examples/provisioning/console_prov/README.md
View file

@ -33,8 +33,6 @@ To provision the device running this example, the `esp_prov.py` script needs to
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
* Under Example Configuration set the following : * Under Example Configuration set the following :
* Security Version (default 1) * Security Version (default 1)
* Proof of Possession (default "abcd1234") * Proof of Possession (default "abcd1234")

2
examples/provisioning/custom_config/README.md
View file

@ -32,8 +32,6 @@ To provision the device running this example, the `esp_prov.py` script needs to
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
* Under Example Configuration set the following : * Under Example Configuration set the following :
* SoftAP SSID (Defaults to PROV_<MACID>) * SoftAP SSID (Defaults to PROV_<MACID>)
* SoftAP Password (Defaults to PROV_PASS) * SoftAP Password (Defaults to PROV_PASS)

2
examples/provisioning/manager/README.md
View file

@ -50,8 +50,6 @@ There are various applications, specific to Windows and macOS platform which can
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
### Build and Flash ### Build and Flash
Build the project and flash it to the board, then run monitor tool to view serial output: Build the project and flash it to the board, then run monitor tool to view serial output:

2
examples/provisioning/softap_prov/README.md
View file

@ -45,8 +45,6 @@ To provision the device running this example, the `esp_prov.py` script needs to
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
* Under Example Configuration set the following : * Under Example Configuration set the following :
* SoftAP SSID (Defaults to PROV_<MACID>) * SoftAP SSID (Defaults to PROV_<MACID>)
* SoftAP Password (Defaults to PROV_PASS) * SoftAP Password (Defaults to PROV_PASS)

2
examples/security/flash_encryption/README.md
View file

@ -14,8 +14,6 @@ The example also demonstrates writing and reading encrypted partitions in flash.
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
* Enable the flash encryption mode (Development or Release) under Security Features. Default usage mode is Development (recommended during test and development phase). * Enable the flash encryption mode (Development or Release) under Security Features. Default usage mode is Development (recommended during test and development phase).
* Ensure Bootloader log verbosity is Info under Bootloader config. * Ensure Bootloader log verbosity is Info under Bootloader config.

4
examples/system/himem/README.md
View file

@ -24,8 +24,6 @@ This example requires an ESP32 with external SPI RAM connected, for instance an
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
* Make sure that SPI RAM bank switching is enabled. (Compiling the example with default values will automatically enable this.) It can be found under `Component config > ESP32-specific > Support for external, SPI-connected RAM > SPI RAM config`. * Make sure that SPI RAM bank switching is enabled. (Compiling the example with default values will automatically enable this.) It can be found under `Component config > ESP32-specific > Support for external, SPI-connected RAM > SPI RAM config`.
### Build and Flash ### Build and Flash
@ -99,4 +97,4 @@ I (0) cpu_start: Starting scheduler on APP CPU.
I (132) spiram: Reserving pool of 32K of internal memory for DMA/internal allocations I (132) spiram: Reserving pool of 32K of internal memory for DMA/internal allocations
Himem has 6080 KiB of memory, 6080 KiB of which is free. Testing the free memory... Himem has 6080 KiB of memory, 6080 KiB of which is free. Testing the free memory...
Done! Done!
``` ```

8
examples/system/perfmon/README.md
View file

@ -18,14 +18,14 @@ Example should be able to run on any commonly available ESP32 development board.
### Configure the project ### Configure the project
``` ```
make menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
### Build and Flash ### Build and Flash
Enter `make -j4 flash monitor` if you are using GNU Make based build system or enter `idf.py build flash monitor` if you' are using CMake based build system. ```
idf.py build flash monitor
```
(To exit the serial monitor, type ``Ctrl-]``.) (To exit the serial monitor, type ``Ctrl-]``.)

1
examples/wifi/espnow/README.md
View file

@ -34,7 +34,6 @@ to make ESPNOW data more safe and more reliable.
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
* Set WiFi mode (station or SoftAP) under Example Configuration Options. * Set WiFi mode (station or SoftAP) under Example Configuration Options.
* Set ESPNOW primary master key under Example Configuration Options. * Set ESPNOW primary master key under Example Configuration Options.
This parameter must be set to the same value for sending and recving devices. This parameter must be set to the same value for sending and recving devices.

2
examples/wifi/getting_started/softAP/README.md
View file

@ -11,8 +11,6 @@
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
* Set WiFi SSID and WiFi Password and Maximal STA connections under Example Configuration Options. * Set WiFi SSID and WiFi Password and Maximal STA connections under Example Configuration Options.
### Build and Flash ### Build and Flash

2
examples/wifi/getting_started/station/README.md
View file

@ -11,8 +11,6 @@
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
* Set WiFi SSID and WiFi Password and Maximum retry under Example Configuration Options. * Set WiFi SSID and WiFi Password and Maximum retry under Example Configuration Options.
### Build and Flash ### Build and Flash

2
examples/wifi/smart_config/README.md
View file

@ -16,8 +16,6 @@ Download ESPTOUCH APP from app store:
idf.py menuconfig idf.py menuconfig
``` ```
* Set serial port under Serial Flasher Options.
### Build and Flash ### Build and Flash
Build the project and flash it to the board, then run monitor tool to view serial output: Build the project and flash it to the board, then run monitor tool to view serial output: