From e7dba7d7bc6218eea440dfe6f55592b8c21f6083 Mon Sep 17 00:00:00 2001 From: Mahavir Jain Date: Fri, 2 Aug 2019 09:01:20 +0530 Subject: [PATCH] examples: change default build instructions in docs to CMake --- examples/README.md | 4 ++-- examples/bluetooth/bluedroid/ble/ble_spp_client/README.md | 2 +- .../bluetooth/bluedroid/classic_bt/a2dp_sink/README.md | 2 +- .../ble_mesh_fast_prov_server/tutorial/EspBleMesh.md | 4 ++-- examples/bluetooth/esp_ble_mesh/ble_mesh_node/README.md | 4 ++-- .../tutorial/Ble_Mesh_Node_Example_Walkthrough.md | 8 ++++---- .../tutorial/ble_mesh_wifi_coexist.md | 6 +++--- examples/bluetooth/nimble/blecent/README.md | 4 ++-- examples/bluetooth/nimble/blehr/README.md | 4 ++-- examples/bluetooth/nimble/blemesh/README.md | 4 ++-- examples/bluetooth/nimble/bleprph/README.md | 4 ++-- examples/ethernet/basic/README.md | 4 ++-- examples/ethernet/iperf/README.md | 4 ++-- examples/peripherals/adc/README.md | 6 +++--- examples/peripherals/adc2/README.md | 6 +++--- examples/peripherals/i2s/README.md | 6 +++--- examples/peripherals/i2s_adc_dac/README.md | 6 +++--- examples/peripherals/ledc/README.md | 6 +++--- examples/peripherals/pcnt/README.md | 6 +++--- examples/peripherals/rmt_nec_tx_rx/README.md | 6 +++--- examples/peripherals/rmt_tx/README.md | 6 +++--- examples/peripherals/sigmadelta/README.md | 4 ++-- examples/peripherals/uart/uart_async_rxtxtasks/README.md | 6 +++--- examples/peripherals/uart/uart_echo/README.md | 6 +++--- examples/peripherals/uart/uart_echo_rs485/README.md | 6 +++--- examples/peripherals/uart/uart_events/README.md | 6 +++--- examples/peripherals/uart/uart_select/README.md | 6 +++--- examples/protocols/asio/chat_client/README.md | 2 +- examples/protocols/coap_client/README.md | 4 ++-- examples/protocols/coap_server/README.md | 4 ++-- examples/protocols/esp_local_ctrl/README.md | 2 +- examples/protocols/esp_local_ctrl/main/app_main.c | 2 +- examples/protocols/http_server/file_serving/README.md | 2 +- examples/protocols/mdns/README.md | 2 +- examples/protocols/modbus_master/README.md | 4 ++-- examples/protocols/modbus_slave/README.md | 4 ++-- examples/protocols/mqtt/publish_test/README.md | 2 +- examples/protocols/mqtt/ssl/README.md | 2 +- examples/protocols/mqtt/ssl_mutual_auth/README.md | 2 +- examples/protocols/mqtt/tcp/README.md | 4 ++-- examples/protocols/mqtt/ws/README.md | 2 +- examples/protocols/mqtt/wss/README.md | 2 +- examples/protocols/sockets/README.md | 4 ++-- 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 | 6 +++--- examples/provisioning/console_prov/README.md | 6 +++--- examples/provisioning/custom_config/README.md | 6 +++--- examples/provisioning/manager/README.md | 4 ++-- examples/provisioning/softap_prov/README.md | 6 +++--- examples/security/flash_encryption/README.md | 8 ++++---- examples/storage/spiffsgen/README.md | 8 ++++---- examples/storage/spiffsgen/main/CMakeLists.txt | 2 +- examples/system/freertos/real_time_stats/README.md | 4 ++-- examples/system/himem/README.md | 4 ++-- examples/system/network_tests/README.md | 5 ++--- examples/wifi/espnow/README.md | 4 ++-- examples/wifi/getting_started/softAP/README.md | 4 ++-- examples/wifi/getting_started/station/README.md | 4 ++-- examples/wifi/power_save/main/power_save.c | 2 +- examples/wifi/smart_config/README.md | 4 ++-- 63 files changed, 136 insertions(+), 137 deletions(-) diff --git a/examples/README.md b/examples/README.md index e5b4a0c4fc..9728c32166 100644 --- a/examples/README.md +++ b/examples/README.md @@ -26,8 +26,8 @@ Building an example is the same as building any other project: * Follow the Getting Started instructions which include building the "Hello World" example. * Change into the directory of the new example you'd like to build. * Run `idf.py menuconfig` to open the project configuration menu. Most examples have a project-specific "Example Configuration" section here (for example, to set the WiFi SSID & password to use). -* `make` to build the example. -* Follow the printed instructions to flash, or run `idf.py flash`. +* `idf.py build` to build the example. +* Follow the printed instructions to flash, or run `idf.py -p PORT flash`. # Copying Examples diff --git a/examples/bluetooth/bluedroid/ble/ble_spp_client/README.md b/examples/bluetooth/bluedroid/ble/ble_spp_client/README.md index afae60f766..a384731266 100644 --- a/examples/bluetooth/bluedroid/ble/ble_spp_client/README.md +++ b/examples/bluetooth/bluedroid/ble/ble_spp_client/README.md @@ -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-]``.) diff --git a/examples/bluetooth/bluedroid/classic_bt/a2dp_sink/README.md b/examples/bluetooth/bluedroid/classic_bt/a2dp_sink/README.md index 7d0889eccc..cd57b59d7e 100644 --- a/examples/bluetooth/bluedroid/classic_bt/a2dp_sink/README.md +++ b/examples/bluetooth/bluedroid/classic_bt/a2dp_sink/README.md @@ -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-]``.) diff --git a/examples/bluetooth/esp_ble_mesh/ble_mesh_fast_provision/ble_mesh_fast_prov_server/tutorial/EspBleMesh.md b/examples/bluetooth/esp_ble_mesh/ble_mesh_fast_provision/ble_mesh_fast_prov_server/tutorial/EspBleMesh.md index 0d087ce2d9..8039d6672c 100644 --- a/examples/bluetooth/esp_ble_mesh/ble_mesh_fast_provision/ble_mesh_fast_prov_server/tutorial/EspBleMesh.md +++ b/examples/bluetooth/esp_ble_mesh/ble_mesh_fast_provision/ble_mesh_fast_prov_server/tutorial/EspBleMesh.md @@ -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) diff --git a/examples/bluetooth/esp_ble_mesh/ble_mesh_node/README.md b/examples/bluetooth/esp_ble_mesh/ble_mesh_node/README.md index c84d2dfd00..85b2147ee5 100644 --- a/examples/bluetooth/esp_ble_mesh/ble_mesh_node/README.md +++ b/examples/bluetooth/esp_ble_mesh/ble_mesh_node/README.md @@ -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. diff --git a/examples/bluetooth/esp_ble_mesh/ble_mesh_node/tutorial/Ble_Mesh_Node_Example_Walkthrough.md b/examples/bluetooth/esp_ble_mesh/ble_mesh_node/tutorial/Ble_Mesh_Node_Example_Walkthrough.md index 8776590045..cdde9bfdb1 100644 --- a/examples/bluetooth/esp_ble_mesh/ble_mesh_node/tutorial/Ble_Mesh_Node_Example_Walkthrough.md +++ b/examples/bluetooth/esp_ble_mesh/ble_mesh_node/tutorial/Ble_Mesh_Node_Example_Walkthrough.md @@ -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 diff --git a/examples/bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist/tutorial/ble_mesh_wifi_coexist.md b/examples/bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist/tutorial/ble_mesh_wifi_coexist.md index e60446ca72..2acdb4764c 100644 --- a/examples/bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist/tutorial/ble_mesh_wifi_coexist.md +++ b/examples/bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist/tutorial/ble_mesh_wifi_coexist.md @@ -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 */ ``` diff --git a/examples/bluetooth/nimble/blecent/README.md b/examples/bluetooth/nimble/blecent/README.md index 4b531f9787..7724aba48f 100644 --- a/examples/bluetooth/nimble/blecent/README.md +++ b/examples/bluetooth/nimble/blecent/README.md @@ -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-]``.) diff --git a/examples/bluetooth/nimble/blehr/README.md b/examples/bluetooth/nimble/blehr/README.md index af4b0581f6..067769dccc 100644 --- a/examples/bluetooth/nimble/blehr/README.md +++ b/examples/bluetooth/nimble/blehr/README.md @@ -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-]``.) diff --git a/examples/bluetooth/nimble/blemesh/README.md b/examples/bluetooth/nimble/blemesh/README.md index 0f991b5996..9c44bbb254 100644 --- a/examples/bluetooth/nimble/blemesh/README.md +++ b/examples/bluetooth/nimble/blemesh/README.md @@ -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-]``.) diff --git a/examples/bluetooth/nimble/bleprph/README.md b/examples/bluetooth/nimble/bleprph/README.md index 6f0d96e8a5..b518c81f82 100644 --- a/examples/bluetooth/nimble/bleprph/README.md +++ b/examples/bluetooth/nimble/bleprph/README.md @@ -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-]``.) diff --git a/examples/ethernet/basic/README.md b/examples/ethernet/basic/README.md index 57f4b472cd..8f5552dcf0 100644 --- a/examples/ethernet/basic/README.md +++ b/examples/ethernet/basic/README.md @@ -21,7 +21,7 @@ To run this example, it's recommended that you have an official ESP32 Ethernet d ### Project configuration in menuconfig -Enter `make menuconfig` if you are using GNU Make based build system or enter `idf.py menuconfig` if you' are using CMake based build system. +Enter `idf.py menuconfig` if you are using GNU Make based build system or enter `idf.py menuconfig` if you' are using CMake based build system. 1. In the `Example Configuration` menu: * Choose the kind of Ethernet this example will run on under `Ethernet Type`. @@ -59,7 +59,7 @@ Enter `make menuconfig` if you are using GNU Make based build system or enter `i ### 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. +Enter `idf.py -p PORT 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. (To exit the serial monitor, type ``Ctrl-]``.) diff --git a/examples/ethernet/iperf/README.md b/examples/ethernet/iperf/README.md index c75e90096a..b33bab61d7 100644 --- a/examples/ethernet/iperf/README.md +++ b/examples/ethernet/iperf/README.md @@ -25,7 +25,7 @@ To run this example, it's recommended that you have an official ESP32 Ethernet d ### Project configuration in menuconfig -Enter `make menuconfig` if you are using GNU Make based build system or enter `idf.py menuconfig` if you' are using CMake based build system. +Enter `idf.py menuconfig` if you are using GNU Make based build system or enter `idf.py menuconfig` if you' are using CMake based build system. 1. In the `Example Configuration` menu: * Enable storing history commands in flash under `Store command history in flash`. @@ -63,7 +63,7 @@ Enter `make menuconfig` if you are using GNU Make based build system or enter `i ### 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. +Enter `idf.py -p PORT 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. (To exit the serial monitor, type ``Ctrl-]``.) diff --git a/examples/peripherals/adc/README.md b/examples/peripherals/adc/README.md index 47f58c94b9..b392e99570 100644 --- a/examples/peripherals/adc/README.md +++ b/examples/peripherals/adc/README.md @@ -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. diff --git a/examples/peripherals/adc2/README.md b/examples/peripherals/adc2/README.md index 32b94f68ed..3130072b57 100644 --- a/examples/peripherals/adc2/README.md +++ b/examples/peripherals/adc2/README.md @@ -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. diff --git a/examples/peripherals/i2s/README.md b/examples/peripherals/i2s/README.md index a02f3e5e60..11c881dfa6 100644 --- a/examples/peripherals/i2s/README.md +++ b/examples/peripherals/i2s/README.md @@ -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. diff --git a/examples/peripherals/i2s_adc_dac/README.md b/examples/peripherals/i2s_adc_dac/README.md index 7d43ef845a..c3c85b6c74 100644 --- a/examples/peripherals/i2s_adc_dac/README.md +++ b/examples/peripherals/i2s_adc_dac/README.md @@ -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. diff --git a/examples/peripherals/ledc/README.md b/examples/peripherals/ledc/README.md index c66fa19ddc..542d0b3762 100644 --- a/examples/peripherals/ledc/README.md +++ b/examples/peripherals/ledc/README.md @@ -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. diff --git a/examples/peripherals/pcnt/README.md b/examples/peripherals/pcnt/README.md index 6e0beb6c07..84721c562b 100644 --- a/examples/peripherals/pcnt/README.md +++ b/examples/peripherals/pcnt/README.md @@ -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. diff --git a/examples/peripherals/rmt_nec_tx_rx/README.md b/examples/peripherals/rmt_nec_tx_rx/README.md index 073859111d..e5a15025de 100644 --- a/examples/peripherals/rmt_nec_tx_rx/README.md +++ b/examples/peripherals/rmt_nec_tx_rx/README.md @@ -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. diff --git a/examples/peripherals/rmt_tx/README.md b/examples/peripherals/rmt_tx/README.md index 6b7f1ff171..cd32a7e2b7 100644 --- a/examples/peripherals/rmt_tx/README.md +++ b/examples/peripherals/rmt_tx/README.md @@ -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. diff --git a/examples/peripherals/sigmadelta/README.md b/examples/peripherals/sigmadelta/README.md index 23af6cf8de..14e0dacfef 100644 --- a/examples/peripherals/sigmadelta/README.md +++ b/examples/peripherals/sigmadelta/README.md @@ -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-]``.) diff --git a/examples/peripherals/uart/uart_async_rxtxtasks/README.md b/examples/peripherals/uart/uart_async_rxtxtasks/README.md index d103ccf541..3bc54d5784 100644 --- a/examples/peripherals/uart/uart_async_rxtxtasks/README.md +++ b/examples/peripherals/uart/uart_async_rxtxtasks/README.md @@ -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-]``.) diff --git a/examples/peripherals/uart/uart_echo/README.md b/examples/peripherals/uart/uart_echo/README.md index 797393a85d..6da7c5c6e9 100644 --- a/examples/peripherals/uart/uart_echo/README.md +++ b/examples/peripherals/uart/uart_echo/README.md @@ -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-]``.) diff --git a/examples/peripherals/uart/uart_echo_rs485/README.md b/examples/peripherals/uart/uart_echo_rs485/README.md index f2c23f7c9b..97c3373ba0 100644 --- a/examples/peripherals/uart/uart_echo_rs485/README.md +++ b/examples/peripherals/uart/uart_echo_rs485/README.md @@ -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-]``.) diff --git a/examples/peripherals/uart/uart_events/README.md b/examples/peripherals/uart/uart_events/README.md index 677ffe4b00..5cd3898e70 100644 --- a/examples/peripherals/uart/uart_events/README.md +++ b/examples/peripherals/uart/uart_events/README.md @@ -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-]``.) diff --git a/examples/peripherals/uart/uart_select/README.md b/examples/peripherals/uart/uart_select/README.md index f02f6b7f4e..ffe87895c2 100644 --- a/examples/peripherals/uart/uart_select/README.md +++ b/examples/peripherals/uart/uart_select/README.md @@ -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-]``.) diff --git a/examples/protocols/asio/chat_client/README.md b/examples/protocols/asio/chat_client/README.md index edc4c71897..bcc2bd4d5e 100644 --- a/examples/protocols/asio/chat_client/README.md +++ b/examples/protocols/asio/chat_client/README.md @@ -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 diff --git a/examples/protocols/coap_client/README.md b/examples/protocols/coap_client/README.md index d058e3c311..bc3159dbb7 100644 --- a/examples/protocols/coap_client/README.md +++ b/examples/protocols/coap_client/README.md @@ -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-]``.) diff --git a/examples/protocols/coap_server/README.md b/examples/protocols/coap_server/README.md index 44366936d0..cf00279a49 100644 --- a/examples/protocols/coap_server/README.md +++ b/examples/protocols/coap_server/README.md @@ -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-]``.) diff --git a/examples/protocols/esp_local_ctrl/README.md b/examples/protocols/esp_local_ctrl/README.md index 81abdea2e8..b16b485470 100644 --- a/examples/protocols/esp_local_ctrl/README.md +++ b/examples/protocols/esp_local_ctrl/README.md @@ -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 diff --git a/examples/protocols/esp_local_ctrl/main/app_main.c b/examples/protocols/esp_local_ctrl/main/app_main.c index d19feffda1..521be92b5d 100644 --- a/examples/protocols/esp_local_ctrl/main/app_main.c +++ b/examples/protocols/esp_local_ctrl/main/app_main.c @@ -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" diff --git a/examples/protocols/http_server/file_serving/README.md b/examples/protocols/http_server/file_serving/README.md index 475cd7b0c7..e4a891dd41 100644 --- a/examples/protocols/http_server/file_serving/README.md +++ b/examples/protocols/http_server/file_serving/README.md @@ -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 diff --git a/examples/protocols/mdns/README.md b/examples/protocols/mdns/README.md index 2392699b60..2b99f2d4c2 100644 --- a/examples/protocols/mdns/README.md +++ b/examples/protocols/mdns/README.md @@ -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 diff --git a/examples/protocols/modbus_master/README.md b/examples/protocols/modbus_master/README.md index bcd24b2946..c700f4b29b 100644 --- a/examples/protocols/modbus_master/README.md +++ b/examples/protocols/modbus_master/README.md @@ -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-]``.) diff --git a/examples/protocols/modbus_slave/README.md b/examples/protocols/modbus_slave/README.md index 6ef854836b..6d671781f1 100644 --- a/examples/protocols/modbus_slave/README.md +++ b/examples/protocols/modbus_slave/README.md @@ -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-]``.) diff --git a/examples/protocols/mqtt/publish_test/README.md b/examples/protocols/mqtt/publish_test/README.md index d3db836410..ee377d5a64 100644 --- a/examples/protocols/mqtt/publish_test/README.md +++ b/examples/protocols/mqtt/publish_test/README.md @@ -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-]``.) diff --git a/examples/protocols/mqtt/ssl/README.md b/examples/protocols/mqtt/ssl/README.md index db711fdcf1..e2693729d4 100644 --- a/examples/protocols/mqtt/ssl/README.md +++ b/examples/protocols/mqtt/ssl/README.md @@ -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-]``.) diff --git a/examples/protocols/mqtt/ssl_mutual_auth/README.md b/examples/protocols/mqtt/ssl_mutual_auth/README.md index bf5b57d704..0696a4e16e 100644 --- a/examples/protocols/mqtt/ssl_mutual_auth/README.md +++ b/examples/protocols/mqtt/ssl_mutual_auth/README.md @@ -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-]``.) diff --git a/examples/protocols/mqtt/tcp/README.md b/examples/protocols/mqtt/tcp/README.md index 7920a75e9e..7fe788cd1a 100644 --- a/examples/protocols/mqtt/tcp/README.md +++ b/examples/protocols/mqtt/tcp/README.md @@ -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-]``.) diff --git a/examples/protocols/mqtt/ws/README.md b/examples/protocols/mqtt/ws/README.md index d0eff6be29..c0526b0735 100644 --- a/examples/protocols/mqtt/ws/README.md +++ b/examples/protocols/mqtt/ws/README.md @@ -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-]``.) diff --git a/examples/protocols/mqtt/wss/README.md b/examples/protocols/mqtt/wss/README.md index 1877979308..9851d54337 100644 --- a/examples/protocols/mqtt/wss/README.md +++ b/examples/protocols/mqtt/wss/README.md @@ -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-]``.) diff --git a/examples/protocols/sockets/README.md b/examples/protocols/sockets/README.md index 9fbc850db9..9d52415321 100644 --- a/examples/protocols/sockets/README.md +++ b/examples/protocols/sockets/README.md @@ -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-]``.) diff --git a/examples/protocols/sockets/tcp_client/README.md b/examples/protocols/sockets/tcp_client/README.md index 415dea814e..af3348ed39 100644 --- a/examples/protocols/sockets/tcp_client/README.md +++ b/examples/protocols/sockets/tcp_client/README.md @@ -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-]``.) diff --git a/examples/protocols/sockets/tcp_server/README.md b/examples/protocols/sockets/tcp_server/README.md index ce47646c98..ca72ff01bc 100644 --- a/examples/protocols/sockets/tcp_server/README.md +++ b/examples/protocols/sockets/tcp_server/README.md @@ -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-]``.) diff --git a/examples/protocols/sockets/udp_client/README.md b/examples/protocols/sockets/udp_client/README.md index 7232fb9f45..85bdaa8304 100644 --- a/examples/protocols/sockets/udp_client/README.md +++ b/examples/protocols/sockets/udp_client/README.md @@ -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-]``.) diff --git a/examples/protocols/sockets/udp_server/README.md b/examples/protocols/sockets/udp_server/README.md index 3bf1fe370a..bbfbd60327 100644 --- a/examples/protocols/sockets/udp_server/README.md +++ b/examples/protocols/sockets/udp_server/README.md @@ -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-]``.) diff --git a/examples/provisioning/ble_prov/README.md b/examples/provisioning/ble_prov/README.md index fa49ba8e4d..1c871e6572 100644 --- a/examples/provisioning/ble_prov/README.md +++ b/examples/provisioning/ble_prov/README.md @@ -47,7 +47,7 @@ There are various applications, specific to Windows and macOS platform which can ### Configure the project ``` -make menuconfig +idf.py menuconfig ``` * Set serial port under Serial Flasher Options. @@ -61,7 +61,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-]``.) @@ -140,7 +140,7 @@ It means the Wi-Fi credentials were already set by some other application flashe ``` make erase_flash -make -j4 flash monitor +idf.py -p PORT flash monitor ``` Or, enable `Reset Provisioning` option under `Example Configuration` under menuconfig. But this will erase the saved Wi-Fi credentials every time the device boots, so this is not the preferred solution. diff --git a/examples/provisioning/console_prov/README.md b/examples/provisioning/console_prov/README.md index 0732c54505..685fdf66c5 100644 --- a/examples/provisioning/console_prov/README.md +++ b/examples/provisioning/console_prov/README.md @@ -30,7 +30,7 @@ To provision the device running this example, the `esp_prov.py` script needs to ### Configure the project ``` -make menuconfig +idf.py menuconfig ``` * Set serial port under Serial Flasher Options. @@ -44,7 +44,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-]``.) @@ -202,7 +202,7 @@ It means the Wi-Fi credentials were already set by some other application flashe ``` make erase_flash -make -j4 flash monitor +idf.py -p PORT flash monitor ``` Or, enable `Reset Provisioning` option under `Example Configuration` under menuconfig. But this will erase the saved Wi-Fi credentials every time the device boots, so this is not the preferred solution. diff --git a/examples/provisioning/custom_config/README.md b/examples/provisioning/custom_config/README.md index 82ed6ffe31..dba1854a61 100644 --- a/examples/provisioning/custom_config/README.md +++ b/examples/provisioning/custom_config/README.md @@ -29,7 +29,7 @@ To provision the device running this example, the `esp_prov.py` script needs to ### Configure the project ``` -make menuconfig +idf.py menuconfig ``` * Set serial port under Serial Flasher Options. @@ -45,7 +45,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-]``.) @@ -138,7 +138,7 @@ It means the Wi-Fi credentials were already set by some other application flashe ``` make erase_flash -make -j4 flash monitor +idf.py -p PORT flash monitor ``` Or, enable `Reset Provisioning` option under `Example Configuration` under menuconfig. But this will erase the saved Wi-Fi credentials every time the device boots, so this is not the preferred solution. diff --git a/examples/provisioning/manager/README.md b/examples/provisioning/manager/README.md index b59f83710b..d514d7bdec 100644 --- a/examples/provisioning/manager/README.md +++ b/examples/provisioning/manager/README.md @@ -47,7 +47,7 @@ There are various applications, specific to Windows and macOS platform which can ### Configure the project ``` -make menuconfig +idf.py menuconfig ``` * Set serial port under Serial Flasher Options. @@ -57,7 +57,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-]``.) diff --git a/examples/provisioning/softap_prov/README.md b/examples/provisioning/softap_prov/README.md index 56d092dbfa..086a18e633 100644 --- a/examples/provisioning/softap_prov/README.md +++ b/examples/provisioning/softap_prov/README.md @@ -42,7 +42,7 @@ To provision the device running this example, the `esp_prov.py` script needs to ### Configure the project ``` -make menuconfig +idf.py menuconfig ``` * Set serial port under Serial Flasher Options. @@ -58,7 +58,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-]``.) @@ -145,7 +145,7 @@ It means the Wi-Fi credentials were already set by some other application flashe ``` make erase_flash -make -j4 flash monitor +idf.py -p PORT flash monitor ``` Or, enable `Reset Provisioning` option under `Example Configuration` under menuconfig. But this will erase the saved Wi-Fi credentials every time the device boots, so this is not the preferred solution. diff --git a/examples/security/flash_encryption/README.md b/examples/security/flash_encryption/README.md index f65d1bb163..750ee2a7b8 100644 --- a/examples/security/flash_encryption/README.md +++ b/examples/security/flash_encryption/README.md @@ -8,7 +8,7 @@ The example checks if the flash encryption feature is enabled/disabled and if en ### Configure the project ``` -make menuconfig +idf.py menuconfig ``` * Set serial port under Serial Flasher Options. @@ -24,7 +24,7 @@ make menuconfig When building the project and flashing it to the board FOR THE FIRST TIME after enabling flash encryption feature in menuconfig, run following command to program ESP32 and monitor the output ``` -make -j4 flash monitor +idf.py -p PORT flash monitor ``` (To exit the serial monitor, type ``Ctrl-]``.) @@ -34,13 +34,13 @@ See the Getting Started Guide for full steps to configure and use ESP-IDF to bui When reprogramming the device subsequently use following command for encrypted write of new plaintext application ``` -make -j4 encrypted-app-flash monitor +idf.py encrypted-app-flash monitor ``` Please note above command programs only the app partition. In order to reprogram all partitions (bootloader, partition table and application) in encrypted form use ``` -make -j4 encrypted-flash monitor +idf.py encrypted-flash monitor ``` ## Example Output diff --git a/examples/storage/spiffsgen/README.md b/examples/storage/spiffsgen/README.md index 1176d343d5..b1d34048ba 100644 --- a/examples/storage/spiffsgen/README.md +++ b/examples/storage/spiffsgen/README.md @@ -4,7 +4,7 @@ This example demonstrates how to use the SPIFFS image generation tool [spiffsgen.py](../../../components/spiffs/spiffsgen.py) to automatically create a SPIFFS filesystem image from the contents of a host folder during build, with an option of -automatically flashing the created image on invocation of `idf.py flash`. +automatically flashing the created image on invocation of `idf.py -p PORT flash`. For more information, see description of `spiffsgen.py` on the ESP-IDF Programming Guide under API Reference > Storage > SPIFFS Filesystem. The following gives an overview of the example: @@ -14,10 +14,10 @@ The following gives an overview of the example: 2. The function `spiffs_create_partition_image` is used to specify that a SPIFFS image should be created during build for the `storage` partition. For CMake, it is called from [the main component's CMakeLists.txt](./main/CMakeLists.txt); for Make, from the [project Makefile](./Makefile). `FLASH_IN_PROJECT` specifies that the created image -should be flashed on invocation of `idf.py flash` together with app, bootloader, partition table, etc. +should be flashed on invocation of `idf.py -p PORT flash` together with app, bootloader, partition table, etc. For both build systems, the image is created on the example's build directory with the output filename `storage.bin`. -3. Upon invocation of `idf.py flash monitor`, application loads and +3. Upon invocation of `idf.py -p PORT flash monitor`, application loads and finds there is already a valid SPIFFS filesystem in the `storage` partition with files same as those in `spiffs_image` directory. The application is then able to read those files. @@ -34,7 +34,7 @@ make flash monitor or ```CMake # CMake -idf.py flash monitor +idf.py -p PORT flash monitor ``` (To exit the serial monitor, type ``Ctrl-]``.) diff --git a/examples/storage/spiffsgen/main/CMakeLists.txt b/examples/storage/spiffsgen/main/CMakeLists.txt index 6153893c3c..3c74aed1b3 100644 --- a/examples/storage/spiffsgen/main/CMakeLists.txt +++ b/examples/storage/spiffsgen/main/CMakeLists.txt @@ -4,5 +4,5 @@ idf_component_register(SRCS "spiffsgen_example_main.c" # Create a SPIFFS image from the contents of the 'spiffs_image' directory # that fits the partition named 'storage'. FLASH_IN_PROJECT indicates that # the generated image should be flashed when the entire project is flashed to -# the target with 'idf.py flash'. +# the target with 'idf.py -p PORT flash'. spiffs_create_partition_image(storage ../spiffs_image FLASH_IN_PROJECT) diff --git a/examples/system/freertos/real_time_stats/README.md b/examples/system/freertos/real_time_stats/README.md index 1ee73a34f1..51e49832e1 100644 --- a/examples/system/freertos/real_time_stats/README.md +++ b/examples/system/freertos/real_time_stats/README.md @@ -15,7 +15,7 @@ This example should be able to run on any commonly available ESP32 development b ### Configure the project ``` -make menuconfig +idf.py menuconfig ``` * Set serial port under Serial Flasher Options. @@ -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-]``.) diff --git a/examples/system/himem/README.md b/examples/system/himem/README.md index 0bc8a624c2..7eba56c40c 100644 --- a/examples/system/himem/README.md +++ b/examples/system/himem/README.md @@ -29,7 +29,7 @@ a setup does not make much sense. ### Configure the project ``` -make menuconfig +idf.py menuconfig ``` * Set serial port under Serial Flasher Options. @@ -43,7 +43,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-]``.) diff --git a/examples/system/network_tests/README.md b/examples/system/network_tests/README.md index c9aefd8d34..3c2581972b 100644 --- a/examples/system/network_tests/README.md +++ b/examples/system/network_tests/README.md @@ -23,9 +23,8 @@ Note: TTCN3 engine works reliably only on Linux and Windows. ``` cd $IDF_PATH/examples/system/network_tests -make defconfig -make -j4 -make flash +idf.py build +idf.py -p PORT flash ``` ## Run test diff --git a/examples/wifi/espnow/README.md b/examples/wifi/espnow/README.md index 047cf85a4a..5b375c99ba 100644 --- a/examples/wifi/espnow/README.md +++ b/examples/wifi/espnow/README.md @@ -31,7 +31,7 @@ to make ESPNOW data more safe and more reliable. ### Configure the project ``` -make menuconfig +idf.py menuconfig ``` * Set serial port under Serial Flasher Options. @@ -53,7 +53,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-]``.) diff --git a/examples/wifi/getting_started/softAP/README.md b/examples/wifi/getting_started/softAP/README.md index 8d831d29bd..4b030e01c3 100644 --- a/examples/wifi/getting_started/softAP/README.md +++ b/examples/wifi/getting_started/softAP/README.md @@ -8,7 +8,7 @@ ### Configure the project ``` -make menuconfig +idf.py menuconfig ``` * Set serial port under Serial Flasher Options. @@ -20,7 +20,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-]``.) diff --git a/examples/wifi/getting_started/station/README.md b/examples/wifi/getting_started/station/README.md index 6666da5345..e992df2607 100644 --- a/examples/wifi/getting_started/station/README.md +++ b/examples/wifi/getting_started/station/README.md @@ -8,7 +8,7 @@ ### Configure the project ``` -make menuconfig +idf.py menuconfig ``` * Set serial port under Serial Flasher Options. @@ -20,7 +20,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-]``.) diff --git a/examples/wifi/power_save/main/power_save.c b/examples/wifi/power_save/main/power_save.c index 04f60cb66d..efa7f41c54 100644 --- a/examples/wifi/power_save/main/power_save.c +++ b/examples/wifi/power_save/main/power_save.c @@ -20,7 +20,7 @@ #include "esp_pm.h" #include "nvs_flash.h" -/*set the ssid and password via "make menuconfig"*/ +/*set the ssid and password via "idf.py menuconfig"*/ #define DEFAULT_SSID CONFIG_EXAMPLE_WIFI_SSID #define DEFAULT_PWD CONFIG_EXAMPLE_WIFI_PASSWORD diff --git a/examples/wifi/smart_config/README.md b/examples/wifi/smart_config/README.md index 7f8ee90c7d..c8bdbeb9e8 100644 --- a/examples/wifi/smart_config/README.md +++ b/examples/wifi/smart_config/README.md @@ -13,7 +13,7 @@ Download ESPTOUCH APP from app store: ### Configure the project ``` -make menuconfig +idf.py menuconfig ``` * Set serial port under Serial Flasher Options. @@ -23,7 +23,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-]``.)