]> granicus.if.org Git - esp-idf/commitdiff
examples: change default build instructions in docs to CMake
authorMahavir Jain <mahavir@espressif.com>
Fri, 2 Aug 2019 03:31:20 +0000 (09:01 +0530)
committerMahavir Jain <mahavir@espressif.com>
Fri, 2 Aug 2019 11:02:46 +0000 (16:32 +0530)
63 files changed:
examples/README.md
examples/bluetooth/bluedroid/ble/ble_spp_client/README.md
examples/bluetooth/bluedroid/classic_bt/a2dp_sink/README.md
examples/bluetooth/esp_ble_mesh/ble_mesh_fast_provision/ble_mesh_fast_prov_server/tutorial/EspBleMesh.md
examples/bluetooth/esp_ble_mesh/ble_mesh_node/README.md
examples/bluetooth/esp_ble_mesh/ble_mesh_node/tutorial/Ble_Mesh_Node_Example_Walkthrough.md
examples/bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist/tutorial/ble_mesh_wifi_coexist.md
examples/bluetooth/nimble/blecent/README.md
examples/bluetooth/nimble/blehr/README.md
examples/bluetooth/nimble/blemesh/README.md
examples/bluetooth/nimble/bleprph/README.md
examples/ethernet/basic/README.md
examples/ethernet/iperf/README.md
examples/peripherals/adc/README.md
examples/peripherals/adc2/README.md
examples/peripherals/i2s/README.md
examples/peripherals/i2s_adc_dac/README.md
examples/peripherals/ledc/README.md
examples/peripherals/pcnt/README.md
examples/peripherals/rmt_nec_tx_rx/README.md
examples/peripherals/rmt_tx/README.md
examples/peripherals/sigmadelta/README.md
examples/peripherals/uart/uart_async_rxtxtasks/README.md
examples/peripherals/uart/uart_echo/README.md
examples/peripherals/uart/uart_echo_rs485/README.md
examples/peripherals/uart/uart_events/README.md
examples/peripherals/uart/uart_select/README.md
examples/protocols/asio/chat_client/README.md
examples/protocols/coap_client/README.md
examples/protocols/coap_server/README.md
examples/protocols/esp_local_ctrl/README.md
examples/protocols/esp_local_ctrl/main/app_main.c
examples/protocols/http_server/file_serving/README.md
examples/protocols/mdns/README.md
examples/protocols/modbus_master/README.md
examples/protocols/modbus_slave/README.md
examples/protocols/mqtt/publish_test/README.md
examples/protocols/mqtt/ssl/README.md
examples/protocols/mqtt/ssl_mutual_auth/README.md
examples/protocols/mqtt/tcp/README.md
examples/protocols/mqtt/ws/README.md
examples/protocols/mqtt/wss/README.md
examples/protocols/sockets/README.md
examples/protocols/sockets/tcp_client/README.md
examples/protocols/sockets/tcp_server/README.md
examples/protocols/sockets/udp_client/README.md
examples/protocols/sockets/udp_server/README.md
examples/provisioning/ble_prov/README.md
examples/provisioning/console_prov/README.md
examples/provisioning/custom_config/README.md
examples/provisioning/manager/README.md
examples/provisioning/softap_prov/README.md
examples/security/flash_encryption/README.md
examples/storage/spiffsgen/README.md
examples/storage/spiffsgen/main/CMakeLists.txt
examples/system/freertos/real_time_stats/README.md
examples/system/himem/README.md
examples/system/network_tests/README.md
examples/wifi/espnow/README.md
examples/wifi/getting_started/softAP/README.md
examples/wifi/getting_started/station/README.md
examples/wifi/power_save/main/power_save.c
examples/wifi/smart_config/README.md

index e5b4a0c4fc694a397286d83a6c1f5cb0020010b6..9728c32166b0082d466bd10064e826ced9351df0 100644 (file)
@@ -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
 
index afae60f76688d74ea88a730148f957cc4aba817c..a38473126696b8de4722fd2a975a0f5fc12daac8 100644 (file)
@@ -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-]``.)
index 7d0889eccca99c3d68fb631cef7979b8882b8fc4..cd57b59d7e7a8f6bf0053ea0fadf6d30c8913db8 100644 (file)
@@ -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-]``.)
index 0d087ce2d949c20de039401b12c728952c0bab5b..8039d6672c434ffb931736aad5cf89d509ab1484 100644 (file)
@@ -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)
 
index c84d2dfd00464f45c719b81307de78fd06ad7345..85b2147ee503ba8c0d917696cea9a35fd13aa62b 100644 (file)
@@ -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.
index 8776590045deed537d191cbfc5b8c83646fa2772..cdde9bfdb1b4c1f14994f87959091a269c4b3836 100644 (file)
@@ -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
index e60446ca72f32c8053d8e8d9682f77ff3dcd8415..2acdb4764cb013d6e21b8fcf3ae2eb1205dfdf4f 100644 (file)
@@ -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 */
 ```
 
index 4b531f9787f8304a2523d8447bdfeb34846a7080..7724aba48f272c1484222d0ef2fb0a272d3cd038 100644 (file)
@@ -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-]``.)
index af4b0581f625e653f8e50816214f4e9405083857..067769dccc77986231f739b23a3300c34b3aaeb0 100644 (file)
@@ -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-]``.)
index 0f991b5996325cf34aeef63fc1d5f37ec8025a68..9c44bbb254f153447a8c3dcb517f3d0b16875aa9 100644 (file)
@@ -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-]``.)
index 6f0d96e8a5149153d8b7f6715b3cd1c08dc0ed50..b518c81f82d57b2b6774222c3488524f67b42e32 100644 (file)
@@ -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-]``.)
index 57f4b472cdf8c6fd48ed9e471c446dcca6f3d603..8f5552dcf054e6741703b3fe4595830d57aaef80 100644 (file)
@@ -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-]``.)
 
index c75e90096a9ccf99d896cda0a348f56cb605b705..b33bab61d75e5368d795c783a1a0b9bb66f228b0 100644 (file)
@@ -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-]``.)
 
index 47f58c94b9eb3587a14cff3283160db8ba1ab881..b392e995707ff5d1541d4882874044c60c371e9c 100644 (file)
@@ -16,7 +16,7 @@ In this example, we use `ADC_UNIT_1` by default, we need to connect a voltage so
 ### Configure the project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 
 * Set serial port under Serial Flasher Options.
@@ -26,7 +26,7 @@ make menuconfig
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
@@ -48,7 +48,7 @@ Raw: 18           Voltage: 79mV
 
 * program upload failure
 
-    * Hardware connection is not correct: run `idf.py monitor`, and reboot your board to see if there are any output logs.
+    * Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs.
     * The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
 
 For any technical queries, please open an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.
index 32b94f68ede7d7fcff000013f14f0c0ed86df0cf..3130072b573f08b4f5226cad1a36d9a3d949386f 100644 (file)
@@ -16,7 +16,7 @@ We use ADC1_CHANNEL_7 (GPIO27) and DAC_CHANNEL_1 (GPIO25) by default, you need t
 ### Configure the project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 
 * Set serial port under Serial Flasher Options.
@@ -27,7 +27,7 @@ make menuconfig
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
@@ -59,7 +59,7 @@ start conversion.
 
 * program upload failure
 
-    * Hardware connection is not correct: run `idf.py monitor`, and reboot your board to see if there are any output logs.
+    * Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs.
     * The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
 
 For any technical queries, please open an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.
index a02f3e5e6061016db4c97e7ade5de0b1f3bfe0c0..11c881dfa6416864405bc41ac53647605f6f8e86 100644 (file)
@@ -14,7 +14,7 @@ In this example, we generate a 100Hz triangle and sine wave and send it out from
 ### Configure the Project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 
 * Set serial port under Serial Flasher Options.
@@ -24,7 +24,7 @@ make menuconfig
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
@@ -61,7 +61,7 @@ If you have a logic analyzer, you can use a logic analyzer to grab online data.
 
 * Program upload failure
 
-    * Hardware connection is not correct: run `idf.py monitor`, and reboot your board to see if there are any output logs.
+    * Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs.
     * The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
 
 For any technical queries, please open an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.
index 7d43ef845aa439959203c9c70e89f76098f01657..c3c85b6c7415c2535c982e77327beb820c23ca1b 100644 (file)
@@ -35,7 +35,7 @@ The following is the hardware connection:
 ### Configure the Project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 
 * Set serial port under Serial Flasher Options, the flash size should be set to 4 MB.
@@ -48,7 +48,7 @@ make menuconfig
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
@@ -85,7 +85,7 @@ I2S: PLL_D2: Req RATE: 16000, real rate: 1004.000, BITS: 16, CLKM: 83, BCK: 60,
 
 * Program upload failure
 
-    * Hardware connection is not correct: run `idf.py monitor`, and reboot your board to see if there are any output logs.
+    * Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs.
     * The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
 
 For any technical queries, please open an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.
index c66fa19ddcfcf162b451dd5654509388c0a4cde6..542d0b37625bcc0c87a51ad15d8b561b896b0652 100644 (file)
@@ -23,7 +23,7 @@ Connect four LEDs to the following LEDC channels / individual GPIOs:
 ### Configure the project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 
 * Set serial port under Serial Flasher Options.
@@ -33,7 +33,7 @@ make menuconfig
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
@@ -63,7 +63,7 @@ you can also see the following output log on the serial monitor:
 
 * Programming fail
 
-    * Hardware connection is not correct: run `idf.py monitor`, and reboot your board to see if there are any output logs.
+    * Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs.
     * The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
 
 For any technical queries, please open an [issue] (https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.
index 6e0beb6c07641e3bf4fa5c982a9263c97e56190b..84721c562bd46e6c40581272f6d1f1891157ce6b 100644 (file)
@@ -20,7 +20,7 @@ Pin connection:
 ### Configure the project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 
 * Set serial port under Serial Flasher Options.
@@ -30,7 +30,7 @@ make menuconfig
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
@@ -68,7 +68,7 @@ Current counter value :-1
 
 * program upload failure
 
-    * Hardware connection is not correct: run `idf.py monitor`, and reboot your board to see if there are any output logs.
+    * Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs.
     * The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
 
 For any technical queries, please open an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.
index 073859111d6edb4ddca520635a2803744eff8e2b..e5a15025dec4921bebd33f1b973183c3fd666a48 100644 (file)
@@ -25,7 +25,7 @@ The TX pin and RX pin can be modified in top of the main/infrared_nec_main.c fil
 ### Configure the Project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 
 * Set serial port under Serial Flasher Options.
@@ -35,7 +35,7 @@ make menuconfig
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
@@ -74,7 +74,7 @@ NEC: RMT RCV --- addr: 0xda25 cmd: 0xeb14
 
 * Programming fail
 
-    * Hardware connection is not correct: run `idf.py monitor`, and reboot your board to see if there is any output logs.
+    * Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there is any output logs.
     * The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
 
 For any technical queries, please open an [issue] (https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.
index 6b7f1ff171d7114b00649987bfe5771454f79059..cd32a7e2b7f436d2d542bd44260afeb599e37d24 100644 (file)
@@ -30,7 +30,7 @@ GPIO18 +----/\/\/\----+------|>|-----+ GND
 ### Configure the Project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 
 * Set serial port under Serial Flasher Options.
@@ -40,7 +40,7 @@ make menuconfig
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
@@ -61,7 +61,7 @@ RMT Tx: Sample transmission complete
 
 * Programming fail
 
-    * Hardware connection is not correct: run `idf.py monitor`, and reboot your board to see if there is any output logs.
+    * Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there is any output logs.
     * The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
 
 For any technical queries, please open an [issue] (https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.
index 23af6cf8de8b3ac2e5cf78f853ae522ecd083628..14e0dacfefae43f9166b1b35e0caacb8fdd42787 100644 (file)
@@ -24,7 +24,7 @@ By default the GPIO output is 4. To change it, edit the line with `GPIO_NUM_4` i
 ### Configure the project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 
 Set serial port under Serial Flasher Options and save the configuration.
@@ -35,7 +35,7 @@ Set serial port under Serial Flasher Options and save the configuration.
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index d103ccf541df66e8165a01e270acff863d973e9d..3bc54d578416dfa97fd829ffe06d1f3015d73748 100644 (file)
@@ -24,7 +24,7 @@ order to receive back the same data which were sent out.
 ### Configure the project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 or
 ```
@@ -38,11 +38,11 @@ idf.py menuconfig
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 or
 ```
-idf.py flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index 797393a85d685a6b6c7a26e2b12793a8b09950e5..6da7c5c6e98acb6e56031164eff9dab9381fd19a 100644 (file)
@@ -36,7 +36,7 @@ UART1 driver to use the hardware flow control by setting `.flow_ctrl = UART_HW_F
 ### Configure the project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 or
 ```
@@ -50,11 +50,11 @@ idf.py menuconfig
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 or
 ```
-idf.py flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index f2c23f7c9b4bfec28fd311cecbdbe5cb9c8a98d5..97c3373ba0c61b84d97bfd0cad034432b0009bfb 100644 (file)
@@ -45,7 +45,7 @@ Connect USB to RS485 adapter to computer and connect its D+, D- output lines wit
 
 ### Configure the project
 ```
-make menuconfig
+idf.py menuconfig
 ```
 or
 ```
@@ -56,11 +56,11 @@ idf.py menuconfig
 ### Build and Flash
 Build the project and flash it to the board, then run monitor tool to view serial output:
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 or
 ```
-idf.py flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index 677ffe4b0029a5ea772712db3ea11fe1e28316ed..5cd3898e705121ef1ecf573c869313cc48018cec 100644 (file)
@@ -14,7 +14,7 @@ The example can be used with any ESP32 development board connected to a computer
 ### Configure the project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 or
 ```
@@ -28,11 +28,11 @@ idf.py menuconfig
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 or
 ```
-idf.py flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index f02f6b7f4eadf70674dddbcd1383ce14c7114246..ffe87895c237c3188c3292f59c1a231874a42da0 100644 (file)
@@ -26,7 +26,7 @@ through UART.
 ### Configure the project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 or
 ```
@@ -40,11 +40,11 @@ idf.py menuconfig
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 or
 ```
-idf.py flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index edc4c718977bb3e7a3b6cf3b36c72976368fdcb0..bcc2bd4d5e9bbc42b579c88be6f91248be0eff3a 100644 (file)
@@ -6,7 +6,7 @@ Simple Asio chat client using WiFi STA or Ethernet.
 
 - Wi-Fi or Ethernet connection is established, and IP address is obtained.
 - Asio chat client connects to the corresponding server whose port number and IP are defined through the project configuration menu.
-- Chat client receives all messages from other chat clients, also it sends message received from stdin using `idf.py monitor`.
+- Chat client receives all messages from other chat clients, also it sends message received from stdin using `idf.py -p PORT monitor`.
 
 ## Running the example
 
index d058e3c3114e07fbf3af60c5a71ddef2a286a1dd..bc3159dbb7acd478afa530727f1f586823839e2c 100644 (file)
@@ -16,7 +16,7 @@ please refer to [RFC7252](https://www.rfc-editor.org/rfc/pdfrfc/rfc7252.txt.pdf)
 ### Configure the project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 
 * Set serial port under Serial Flasher config
@@ -29,7 +29,7 @@ make menuconfig
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index 44366936d06eb553473ed2d44e98426869d66eba..cf00279a4914625833135640728e01d15ea23f1e 100644 (file)
@@ -16,7 +16,7 @@ please refer to [RFC7252](https://www.rfc-editor.org/rfc/pdfrfc/rfc7252.txt.pdf)
 ### Configure the project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 
 * Set default serial port under Serial Flasher config
@@ -28,7 +28,7 @@ make menuconfig
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index 81abdea2e8c65eb121c2f046ba8560bc89be3eb4..b16b4854703b29f0b11c2ec55b319456a3aa2de8 100644 (file)
@@ -4,7 +4,7 @@ This example creates a `esp_local_ctrl` service over HTTPS transport, for secure
 
 See the `esp_local_ctrl` component documentation for details.
 
-Before using the example, run `make menuconfig` (or `idf.py menuconfig` if using CMake build system) to configure Wi-Fi or Ethernet. See "Establishing Wi-Fi or Ethernet Connection" section in [examples/protocols/README.md](../README.md) for more details.
+Before using the example, run `idf.py menuconfig` (or `idf.py menuconfig` if using CMake build system) to configure Wi-Fi or Ethernet. See "Establishing Wi-Fi or Ethernet Connection" section in [examples/protocols/README.md](../README.md) for more details.
 
 ## Client Side Implementation
 
index d19feffda1e581cadb45afd9031ddc8c0614e247..521be92b5dfe0f36f91c01007b4dcbf2ec8aea9f 100644 (file)
@@ -20,7 +20,7 @@
 #include "lwip/err.h"
 #include "lwip/sys.h"
 
-/* The examples use WiFi configuration that you can set via 'make menuconfig'.
+/* The examples use WiFi configuration that you can set via 'idf.py menuconfig'.
 
    If you'd rather not, just change the below entries to strings with
    the config you want - ie #define EXAMPLE_WIFI_SSID "mywifissid"
index 475cd7b0c70b14caa5d7ded0aa15240544abedb9..e4a891dd41cb8ad42dc86484e6e0c5106a5f16b7 100644 (file)
@@ -27,7 +27,7 @@ File server implementation can be found under `main/file_server.c` which uses SP
 
 * In order to test the file server demo :
     1. compile and burn the firmware `idf.py -p PORT flash`
-    2. run `idf.py monitor` and note down the IP assigned to your ESP module. The default port is 80
+    2. run `idf.py -p PORT monitor` and note down the IP assigned to your ESP module. The default port is 80
     3. test the example interactively on a web browser (assuming IP is 192.168.43.130):
         1. open path `http://192.168.43.130/` or `http://192.168.43.130/index.html` to see an HTML web page with list of files on the server (initially empty)
         2. use the file upload form on the webpage to select and upload a file to the server
index 2392699b60fe3ff16f44754073e1cd547d8c88db..2b99f2d4c23e8d1b69a2c3a8cb220530d7e3d595 100644 (file)
@@ -24,7 +24,7 @@ Shows how to use mDNS to advertise lookup services and hosts
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 - Wait for WiFi to connect to your access point
index bcd24b294670aff57d1dec0ad259d2fa927747b9..c700f4b29bbb73575c9fe51d4229795b93cc17e0 100644 (file)
@@ -72,7 +72,7 @@ ESP32 WROVER KIT 1  |               |   RS-485 side |               |      Exter
 ### Configure the application
 Configure the UART pins used for modbus communication using command and table below.
 ```
-make menuconfig
+idf.py menuconfig
 ```
 
 ```
@@ -98,7 +98,7 @@ Other option is to have the modbus_slave example flashed into ESP32 WROVER KIT b
 ### Build and flash software of master device
 Build the project and flash it to the board, then run monitor tool to view serial output:
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index 6ef854836b48bf10311e0ed84a7efbfdace8b514..6d671781f19708d212f0179ebc6675059c767782 100644 (file)
@@ -30,7 +30,7 @@ ESP32 WROVER KIT 1  |               |   RS-485 side |               |    Modbus
 ### Configure the application
 Configure the UART pins used for modbus communication using command and table below.
 ```
-make menuconfig
+idf.py menuconfig
 ```
 
 ```
@@ -53,7 +53,7 @@ As an example the Modbus Poll application can be used with this example.
 ### Build and flash software
 Build the project and flash it to the board, then run monitor tool to view serial output:
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index d3db836410331cad0cf74bf27f51864dbc1fbc77..ee377d5a64b8b0f62a2631e4cc6032d3372c7be5 100644 (file)
@@ -33,7 +33,7 @@ This example can be executed on any ESP32 board, the only required interface is
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index db711fdcf1921627fbd0a131af5d5d182040c44b..e2693729d4d4818452c19c73513515e38411cb22 100644 (file)
@@ -33,7 +33,7 @@ with text operation.
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index bf5b57d70496baf856395c0b5fda30b00b68fa38..0696a4e16ebf95ffac9943004f64f9a37f6b9150 100644 (file)
@@ -43,7 +43,7 @@ Please note, that the supplied files `client.crt` and `client.key` in the `main`
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index 7920a75e9ef5be2528d86bb0b127192eef6e39be..7fe788cd1a3810cd25f9671a28d1530ab406349d 100644 (file)
@@ -1,7 +1,7 @@
 # ESP-MQTT sample application
 (See the README.md file in the upper level 'examples' directory for more information about examples.)
 
-This example connects to the broker URI selected using `make menuconfig` (using mqtt tcp transport) and as a demonstration subscribes/unsubscribes and send a message on certain topic.
+This example connects to the broker URI selected using `idf.py menuconfig` (using mqtt tcp transport) and as a demonstration subscribes/unsubscribes and send a message on certain topic.
 (Please note that the public broker is maintained by the community so may not be always available, for details please see this [disclaimer](https://iot.eclipse.org/getting-started/#sandboxes))
 
 Note: If the URI equals `FROM_STDIN` then the broker address is read from stdin upon application startup (used for testing)
@@ -25,7 +25,7 @@ This example can be executed on any ESP32 board, the only required interface is
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index d0eff6be296f62cce9a7ac2ccf4f47d58622496e..c0526b0735c360fbb53e937e51780cc1a4cd8910 100644 (file)
@@ -24,7 +24,7 @@ This example can be executed on any ESP32 board, the only required interface is
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index 1877979308259b13ff0685107b4ac4158c86bcdd..9851d54337d1afe1dfa2a560f2dc65091433d9c5 100644 (file)
@@ -34,7 +34,7 @@ with text operation.
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index 9fbc850db998a700b2a6d4385f8de5d90f785099..9d524153218aab569f48c538279251aefc0e03db 100644 (file)
@@ -79,7 +79,7 @@ This example can be run on any commonly available ESP32 development board.
 ## Configure the project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 
 * Set serial port under Serial Flasher Options.
@@ -91,7 +91,7 @@ make menuconfig
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index 415dea814ee359e3bfb76dfa5ab88b657c3beb68..af3348ed390bfc0d3c66e28ea69367edc98c95f4 100644 (file)
@@ -35,7 +35,7 @@ This example can be run on any commonly available ESP32 development board.
 ## Configure the project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 
 Set following parameter under Serial Flasher Options:
@@ -59,7 +59,7 @@ Configure Wi-Fi or Ethernet under "Example Connection Configuration" menu. See "
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index ce47646c9882fb3c47c4448a64bcd149c4cd6a02..ca72ff01bc8d153cac4486196db448915f006c0b 100644 (file)
@@ -37,7 +37,7 @@ This example can be run on any commonly available ESP32 development board.
 ## Configure the project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 
 Set following parameter under Serial Flasher Options:
@@ -57,7 +57,7 @@ Configure Wi-Fi or Ethernet under "Example Connection Configuration" menu. See "
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index 7232fb9f45f578aa1cbab3b6d450ca6a2fa48272..85bdaa83041a139ac7901fe752cb628a5166ff13 100644 (file)
@@ -45,7 +45,7 @@ This example can be run on any commonly available ESP32 development board.
 ## Configure the project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 
 Set following parameter under Serial Flasher Options:
@@ -70,7 +70,7 @@ Configure Wi-Fi or Ethernet under "Example Connection Configuration" menu. See "
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index 3bf1fe370a1cbafb8f4196e8fb52625450402eff..bbfbd603271b51444fdc3950aa1a4fc5bc6adbd5 100644 (file)
@@ -47,7 +47,7 @@ This example can be run on any commonly available ESP32 development board.
 ## Configure the project
 
 ```
-make menuconfig
+idf.py menuconfig
 ```
 
 Set following parameter under Serial Flasher Options:
@@ -67,7 +67,7 @@ Configure Wi-Fi or Ethernet under "Example Connection Configuration" menu. See "
 Build the project and flash it to the board, then run monitor tool to view serial output:
 
 ```
-make -j4 flash monitor
+idf.py -p PORT flash monitor
 ```
 
 (To exit the serial monitor, type ``Ctrl-]``.)
index fa49ba8e4df4b861f9056403b105fbc1d9cec882..1c871e657225877d55ea0de4273f6faf8c7aad90 100644 (file)
@@ -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.
index 0732c54505f1c2035c48b03a2a62e5400002121d..685fdf66c55dce3f0c5bd0fc6db791950f559d8c 100644 (file)
@@ -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.
index 82ed6ffe31a67373ed33d01049017a08473295d6..dba1854a6123640b0eb1fd7efe63c59f7722b151 100644 (file)
@@ -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.
index b59f83710bf7ca994e2ce0b28f373c24662b108a..d514d7bdec300806c3b7c430f252791095aba9b7 100644 (file)
@@ -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-]``.)
index 56d092dbfab535298fa28ae9dc0b302274e56aad..086a18e6339a8d1dc354fc36e74e555ebc642929 100644 (file)
@@ -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.
index f65d1bb163ef6f496791e9c278b967b251c24eb6..750ee2a7b885a557e8c26fa01c9b82a44e69790b 100644 (file)
@@ -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
index 1176d343d5fc7f794c81d12c41879172f5b0ef41..b1d34048ba647dbad410ac3a1b2517cd06d63bea 100644 (file)
@@ -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-]``.)
index 6153893c3c2b80b4421109577a901c9d622ac5ef..3c74aed1b394c62abad4a9f1a55d1532449d9ec1 100644 (file)
@@ -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)
index 1ee73a34f1635ad233c3127046e12a3950c0d9e3..51e49832e19df6e7d30cb9cc40673e17ef5cc557 100644 (file)
@@ -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-]``.)
index 0bc8a624c214885b389ad00f0a35c834ee7206fc..7eba56c40cb1b551642d1fa1acf76497dd32423d 100644 (file)
@@ -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-]``.)
index c9aefd8d345c31676a8d3430c07f0f9015d08450..3c2581972b6f3595e3d4930bd0971a211aac98be 100644 (file)
@@ -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
index 047cf85a4a2c2cad72c9c5c608df80fe50863ef4..5b375c99bac52819cf6c43941d4fe4cb8a0b9c60 100644 (file)
@@ -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-]``.)
index 8d831d29bd46a98ab33ffdc448eb18bd8709c4e6..4b030e01c3d9d713ec2b7601487cc60bbf600109 100644 (file)
@@ -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-]``.)
index 6666da5345f82cf6690752b68d80549778bb3250..e992df2607fbaed3123a42de1fd237d18375451b 100644 (file)
@@ -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-]``.)
index 04f60cb66d8196b9bb431cc199de28f95e28047b..efa7f41c54322115478604d54fb12226d7dc11cb 100644 (file)
@@ -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
 
index 7f8ee90c7d83596a4c329076ccc97787a88fd79b..c8bdbeb9e865fb7b9d5877ca6393f7452f019cb4 100644 (file)
@@ -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-]``.)