From 858f4745fd0597119f836b51322450b35e93308f Mon Sep 17 00:00:00 2001 From: Roland Dobai Date: Wed, 8 Apr 2020 12:36:25 +0200 Subject: [PATCH] example: Remove duplicate commands and invalid serial port information Closes https://github.com/espressif/esp-idf/issues/5049 --- examples/bluetooth/nimble/blecent/README.md | 2 -- examples/bluetooth/nimble/blehr/README.md | 2 -- examples/bluetooth/nimble/blemesh/README.md | 2 -- examples/bluetooth/nimble/bleprph/README.md | 2 -- examples/peripherals/adc/README.md | 2 -- examples/peripherals/adc2/README.md | 2 -- examples/peripherals/i2s/README.md | 2 -- examples/peripherals/i2s_adc_dac/README.md | 2 +- examples/peripherals/ledc/README.md | 2 -- examples/peripherals/pcnt/README.md | 2 -- examples/peripherals/sigmadelta/README.md | 3 --- .../peripherals/uart/uart_async_rxtxtasks/README.md | 10 ---------- examples/peripherals/uart/uart_echo/README.md | 10 ---------- examples/peripherals/uart/uart_echo_rs485/README.md | 9 --------- examples/peripherals/uart/uart_events/README.md | 10 ---------- examples/peripherals/uart/uart_select/README.md | 10 ---------- examples/protocols/sockets/README.md | 2 -- examples/protocols/sockets/tcp_client/README.md | 4 ---- examples/protocols/sockets/tcp_server/README.md | 4 ---- examples/protocols/sockets/udp_client/README.md | 4 ---- examples/protocols/sockets/udp_server/README.md | 4 ---- examples/provisioning/ble_prov/README.md | 2 -- examples/provisioning/console_prov/README.md | 2 -- examples/provisioning/custom_config/README.md | 2 -- examples/provisioning/manager/README.md | 2 -- examples/provisioning/softap_prov/README.md | 2 -- examples/security/flash_encryption/README.md | 2 -- examples/system/himem/README.md | 4 +--- examples/system/perfmon/README.md | 8 ++++---- examples/wifi/espnow/README.md | 1 - examples/wifi/getting_started/softAP/README.md | 2 -- examples/wifi/getting_started/station/README.md | 2 -- examples/wifi/smart_config/README.md | 2 -- 33 files changed, 6 insertions(+), 115 deletions(-) diff --git a/examples/bluetooth/nimble/blecent/README.md b/examples/bluetooth/nimble/blecent/README.md index 7724aba48..36d54221b 100644 --- a/examples/bluetooth/nimble/blecent/README.md +++ b/examples/bluetooth/nimble/blecent/README.md @@ -35,8 +35,6 @@ Note : idf.py menuconfig ``` -* Set serial port under Serial Flasher Options. - ### Build and Flash Build the project and flash it to the board, then run monitor tool to view serial output: diff --git a/examples/bluetooth/nimble/blehr/README.md b/examples/bluetooth/nimble/blehr/README.md index 067769dcc..6e08019cf 100644 --- a/examples/bluetooth/nimble/blehr/README.md +++ b/examples/bluetooth/nimble/blehr/README.md @@ -26,8 +26,6 @@ Note : idf.py menuconfig ``` -* Set serial port under Serial Flasher Options. - ### Build and Flash Build the project and flash it to the board, then run monitor tool to view serial output: diff --git a/examples/bluetooth/nimble/blemesh/README.md b/examples/bluetooth/nimble/blemesh/README.md index 7775e7abe..dc8d1a810 100644 --- a/examples/bluetooth/nimble/blemesh/README.md +++ b/examples/bluetooth/nimble/blemesh/README.md @@ -23,8 +23,6 @@ To test this demo, any BLE mesh provisioner app can be used. idf.py menuconfig ``` -* Set serial port under Serial Flasher Options. - * Select 'Enable BLE mesh functionality' under 'Component config > Bluetooth > Enable NimBLE host stack'. ### Build and Flash diff --git a/examples/bluetooth/nimble/bleprph/README.md b/examples/bluetooth/nimble/bleprph/README.md index 76c4f23ea..e112aea00 100644 --- a/examples/bluetooth/nimble/bleprph/README.md +++ b/examples/bluetooth/nimble/bleprph/README.md @@ -29,8 +29,6 @@ Note : 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'. * Enable/Disable other security related parameters 'Bonding, MITM option, secure connection(SM SC)' from 'Example Configuration'. diff --git a/examples/peripherals/adc/README.md b/examples/peripherals/adc/README.md index b392e9957..d4d9630ae 100644 --- a/examples/peripherals/adc/README.md +++ b/examples/peripherals/adc/README.md @@ -19,8 +19,6 @@ In this example, we use `ADC_UNIT_1` by default, we need to connect a voltage so idf.py menuconfig ``` -* Set serial port under Serial Flasher Options. - ### Build and Flash Build the project and flash it to the board, then run monitor tool to view serial output: diff --git a/examples/peripherals/adc2/README.md b/examples/peripherals/adc2/README.md index aa5a5237f..103622266 100644 --- a/examples/peripherals/adc2/README.md +++ b/examples/peripherals/adc2/README.md @@ -27,8 +27,6 @@ We use ADC1_CHANNEL_7 (GPIO18) and DAC_CHANNEL_1 (GPIO17) by default, you need t ``` idf.py menuconfig ``` - -* Set serial port under Serial Flasher Options. * Set ADC2 and DAC channel in "Example Configuration" ### Build and Flash diff --git a/examples/peripherals/i2s/README.md b/examples/peripherals/i2s/README.md index 37d51437f..04437f97d 100644 --- a/examples/peripherals/i2s/README.md +++ b/examples/peripherals/i2s/README.md @@ -17,8 +17,6 @@ In this example, we generate a 100Hz triangle and sine wave and send it out from idf.py menuconfig ``` -* Set serial port under Serial Flasher Options. - ### Build and Flash Build the project and flash it to the board, then run monitor tool to view serial output: diff --git a/examples/peripherals/i2s_adc_dac/README.md b/examples/peripherals/i2s_adc_dac/README.md index c3c85b6c7..1d87003df 100644 --- a/examples/peripherals/i2s_adc_dac/README.md +++ b/examples/peripherals/i2s_adc_dac/README.md @@ -38,7 +38,7 @@ The following is the hardware connection: 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". (Note that you can use `sdkconfig.defaults`) diff --git a/examples/peripherals/ledc/README.md b/examples/peripherals/ledc/README.md index 542d0b376..980361cc7 100644 --- a/examples/peripherals/ledc/README.md +++ b/examples/peripherals/ledc/README.md @@ -26,8 +26,6 @@ Connect four LEDs to the following LEDC channels / individual GPIOs: idf.py menuconfig ``` -* Set serial port under Serial Flasher Options. - ### Build and Flash Build the project and flash it to the board, then run monitor tool to view serial output: diff --git a/examples/peripherals/pcnt/README.md b/examples/peripherals/pcnt/README.md index 84721c562..a1c8b1fda 100644 --- a/examples/peripherals/pcnt/README.md +++ b/examples/peripherals/pcnt/README.md @@ -23,8 +23,6 @@ Pin connection: idf.py menuconfig ``` -* Set serial port under Serial Flasher Options. - ### Build and Flash Build the project and flash it to the board, then run monitor tool to view serial output: diff --git a/examples/peripherals/sigmadelta/README.md b/examples/peripherals/sigmadelta/README.md index 14e0dacfe..6655b4597 100644 --- a/examples/peripherals/sigmadelta/README.md +++ b/examples/peripherals/sigmadelta/README.md @@ -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 ``` -Set serial port under Serial Flasher Options and save the configuration. - - ### Build and Flash Build the project and flash it to the board, then run monitor tool to view serial output: diff --git a/examples/peripherals/uart/uart_async_rxtxtasks/README.md b/examples/peripherals/uart/uart_async_rxtxtasks/README.md index 3bc54d578..27987ce81 100644 --- a/examples/peripherals/uart/uart_async_rxtxtasks/README.md +++ b/examples/peripherals/uart/uart_async_rxtxtasks/README.md @@ -26,21 +26,11 @@ order to receive back the same data which were sent out. ``` idf.py menuconfig ``` -or -``` -idf.py menuconfig -``` - -* Set serial port under Serial Flasher Options. ### Build and Flash 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 ``` diff --git a/examples/peripherals/uart/uart_echo/README.md b/examples/peripherals/uart/uart_echo/README.md index 6da7c5c6e..5532fd400 100644 --- a/examples/peripherals/uart/uart_echo/README.md +++ b/examples/peripherals/uart/uart_echo/README.md @@ -38,21 +38,11 @@ UART1 driver to use the hardware flow control by setting `.flow_ctrl = UART_HW_F ``` idf.py menuconfig ``` -or -``` -idf.py menuconfig -``` - -* Set serial port under Serial Flasher Options. ### Build and Flash 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 ``` diff --git a/examples/peripherals/uart/uart_echo_rs485/README.md b/examples/peripherals/uart/uart_echo_rs485/README.md index 97c3373ba..3498fdc11 100644 --- a/examples/peripherals/uart/uart_echo_rs485/README.md +++ b/examples/peripherals/uart/uart_echo_rs485/README.md @@ -47,21 +47,12 @@ Connect USB to RS485 adapter to computer and connect its D+, D- output lines wit ``` 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 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 -``` (To exit the serial monitor, type ``Ctrl-]``.) diff --git a/examples/peripherals/uart/uart_events/README.md b/examples/peripherals/uart/uart_events/README.md index 5cd3898e7..3552dff1e 100644 --- a/examples/peripherals/uart/uart_events/README.md +++ b/examples/peripherals/uart/uart_events/README.md @@ -16,21 +16,11 @@ The example can be used with any ESP32 development board connected to a computer ``` idf.py menuconfig ``` -or -``` -idf.py menuconfig -``` - -* Set serial port under Serial Flasher Options. ### Build and Flash 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 ``` diff --git a/examples/peripherals/uart/uart_select/README.md b/examples/peripherals/uart/uart_select/README.md index ffe87895c..bbd89bc17 100644 --- a/examples/peripherals/uart/uart_select/README.md +++ b/examples/peripherals/uart/uart_select/README.md @@ -28,21 +28,11 @@ through UART. ``` idf.py menuconfig ``` -or -``` -idf.py menuconfig -``` - -* Set serial port under Serial Flasher Options. ### Build and Flash 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 ``` diff --git a/examples/protocols/sockets/README.md b/examples/protocols/sockets/README.md index 9d5241532..1aabb6259 100644 --- a/examples/protocols/sockets/README.md +++ b/examples/protocols/sockets/README.md @@ -82,8 +82,6 @@ This example can be run on any commonly available ESP32 development board. idf.py menuconfig ``` -* Set serial port under Serial Flasher Options. - * Specific configuration for each example can be found in its README.md file. ## Build and Flash diff --git a/examples/protocols/sockets/tcp_client/README.md b/examples/protocols/sockets/tcp_client/README.md index af3348ed3..36ae359e8 100644 --- a/examples/protocols/sockets/tcp_client/README.md +++ b/examples/protocols/sockets/tcp_client/README.md @@ -38,10 +38,6 @@ This example can be run on any commonly available ESP32 development board. idf.py menuconfig ``` -Set following parameter under Serial Flasher Options: - -* Set `Default serial port`. - Set following parameters under Example Configuration Options: * Set `IP version` of example to be IPV4 or IPV6. diff --git a/examples/protocols/sockets/tcp_server/README.md b/examples/protocols/sockets/tcp_server/README.md index ca72ff01b..8ed83999c 100644 --- a/examples/protocols/sockets/tcp_server/README.md +++ b/examples/protocols/sockets/tcp_server/README.md @@ -40,10 +40,6 @@ This example can be run on any commonly available ESP32 development board. idf.py menuconfig ``` -Set following parameter under Serial Flasher Options: - -* Set `Default serial port`. - Set following parameters under Example Configuration Options: * Set `IP version` of the example to be IPV4 or IPV6. diff --git a/examples/protocols/sockets/udp_client/README.md b/examples/protocols/sockets/udp_client/README.md index 85bdaa830..772d39734 100644 --- a/examples/protocols/sockets/udp_client/README.md +++ b/examples/protocols/sockets/udp_client/README.md @@ -48,10 +48,6 @@ This example can be run on any commonly available ESP32 development board. idf.py menuconfig ``` -Set following parameter under Serial Flasher Options: - -* Set `Default serial port`. - Set following parameters under Example Configuration Options: * Set `IP version` of example to be IPV4 or IPV6. diff --git a/examples/protocols/sockets/udp_server/README.md b/examples/protocols/sockets/udp_server/README.md index bbfbd6032..ec93031a9 100644 --- a/examples/protocols/sockets/udp_server/README.md +++ b/examples/protocols/sockets/udp_server/README.md @@ -50,10 +50,6 @@ This example can be run on any commonly available ESP32 development board. idf.py menuconfig ``` -Set following parameter under Serial Flasher Options: - -* Set `Default serial port`. - Set following parameters under Example Configuration Options: * Set `IP version` of the example to be IPV4 or IPV6. diff --git a/examples/provisioning/ble_prov/README.md b/examples/provisioning/ble_prov/README.md index 1c871e657..946073b3b 100644 --- a/examples/provisioning/ble_prov/README.md +++ b/examples/provisioning/ble_prov/README.md @@ -50,8 +50,6 @@ There are various applications, specific to Windows and macOS platform which can idf.py menuconfig ``` -* Set serial port under Serial Flasher Options. - * Under Example Configuration set the following : * Security Version (default 1) * Proof of Possession (default "abcd1234") diff --git a/examples/provisioning/console_prov/README.md b/examples/provisioning/console_prov/README.md index 685fdf66c..a684a973c 100644 --- a/examples/provisioning/console_prov/README.md +++ b/examples/provisioning/console_prov/README.md @@ -33,8 +33,6 @@ To provision the device running this example, the `esp_prov.py` script needs to idf.py menuconfig ``` -* Set serial port under Serial Flasher Options. - * Under Example Configuration set the following : * Security Version (default 1) * Proof of Possession (default "abcd1234") diff --git a/examples/provisioning/custom_config/README.md b/examples/provisioning/custom_config/README.md index dba1854a6..59f0e0341 100644 --- a/examples/provisioning/custom_config/README.md +++ b/examples/provisioning/custom_config/README.md @@ -32,8 +32,6 @@ To provision the device running this example, the `esp_prov.py` script needs to idf.py menuconfig ``` -* Set serial port under Serial Flasher Options. - * Under Example Configuration set the following : * SoftAP SSID (Defaults to PROV_) * SoftAP Password (Defaults to PROV_PASS) diff --git a/examples/provisioning/manager/README.md b/examples/provisioning/manager/README.md index d514d7bde..6c0fd28d6 100644 --- a/examples/provisioning/manager/README.md +++ b/examples/provisioning/manager/README.md @@ -50,8 +50,6 @@ There are various applications, specific to Windows and macOS platform which can idf.py menuconfig ``` -* Set serial port under Serial Flasher Options. - ### Build and Flash Build the project and flash it to the board, then run monitor tool to view serial output: diff --git a/examples/provisioning/softap_prov/README.md b/examples/provisioning/softap_prov/README.md index 086a18e63..7514f4d4d 100644 --- a/examples/provisioning/softap_prov/README.md +++ b/examples/provisioning/softap_prov/README.md @@ -45,8 +45,6 @@ To provision the device running this example, the `esp_prov.py` script needs to idf.py menuconfig ``` -* Set serial port under Serial Flasher Options. - * Under Example Configuration set the following : * SoftAP SSID (Defaults to PROV_) * SoftAP Password (Defaults to PROV_PASS) diff --git a/examples/security/flash_encryption/README.md b/examples/security/flash_encryption/README.md index 3df704a65..ae6323b5a 100644 --- a/examples/security/flash_encryption/README.md +++ b/examples/security/flash_encryption/README.md @@ -14,8 +14,6 @@ The example also demonstrates writing and reading encrypted partitions in flash. 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). * Ensure Bootloader log verbosity is Info under Bootloader config. diff --git a/examples/system/himem/README.md b/examples/system/himem/README.md index d8401c043..805d225a9 100644 --- a/examples/system/himem/README.md +++ b/examples/system/himem/README.md @@ -24,8 +24,6 @@ This example requires an ESP32 with external SPI RAM connected, for instance an 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`. ### 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 Himem has 6080 KiB of memory, 6080 KiB of which is free. Testing the free memory... Done! -``` \ No newline at end of file +``` diff --git a/examples/system/perfmon/README.md b/examples/system/perfmon/README.md index cc2637d09..13fc39594 100644 --- a/examples/system/perfmon/README.md +++ b/examples/system/perfmon/README.md @@ -18,14 +18,14 @@ Example should be able to run on any commonly available ESP32 development board. ### Configure the project ``` -make menuconfig +idf.py menuconfig ``` -* Set serial port under Serial Flasher Options. - ### 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-]``.) diff --git a/examples/wifi/espnow/README.md b/examples/wifi/espnow/README.md index 5b375c99b..db07648a6 100644 --- a/examples/wifi/espnow/README.md +++ b/examples/wifi/espnow/README.md @@ -34,7 +34,6 @@ to make ESPNOW data more safe and more reliable. idf.py menuconfig ``` -* Set serial port under Serial Flasher Options. * Set WiFi mode (station or SoftAP) 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. diff --git a/examples/wifi/getting_started/softAP/README.md b/examples/wifi/getting_started/softAP/README.md index 4b030e01c..f5680275e 100644 --- a/examples/wifi/getting_started/softAP/README.md +++ b/examples/wifi/getting_started/softAP/README.md @@ -11,8 +11,6 @@ idf.py menuconfig ``` -* Set serial port under Serial Flasher Options. - * Set WiFi SSID and WiFi Password and Maximal STA connections under Example Configuration Options. ### Build and Flash diff --git a/examples/wifi/getting_started/station/README.md b/examples/wifi/getting_started/station/README.md index f6e4f7025..e46c3459b 100644 --- a/examples/wifi/getting_started/station/README.md +++ b/examples/wifi/getting_started/station/README.md @@ -11,8 +11,6 @@ idf.py menuconfig ``` -* Set serial port under Serial Flasher Options. - * Set WiFi SSID and WiFi Password and Maximum retry under Example Configuration Options. ### Build and Flash diff --git a/examples/wifi/smart_config/README.md b/examples/wifi/smart_config/README.md index c8bdbeb9e..b94d10068 100644 --- a/examples/wifi/smart_config/README.md +++ b/examples/wifi/smart_config/README.md @@ -16,8 +16,6 @@ Download ESPTOUCH APP from app store: idf.py menuconfig ``` -* Set serial port under Serial Flasher Options. - ### Build and Flash Build the project and flash it to the board, then run monitor tool to view serial output: