ESP32: Fixes for README.md

project-chip · Jun 4, 2021 · 7268e86 · 7268e86
1 parent 7d54157
commit 7268e86
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 20 deletions.
diff --git a/examples/all-clusters-app/esp32/README.md b/examples/all-clusters-app/esp32/README.md
@@ -44,7 +44,6 @@ step. To install these components manually, follow these steps:
           $ cd esp-idf
           $ git checkout release/v4.2
           $ git submodule update --init
-          $ export IDF_PATH=${HOME}/tools/esp-idf
           $ ./install.sh
 
 -   Install ninja-build
@@ -93,7 +92,7 @@ that are currently supported include `ESP32-DevKitC` (default),
     before flashing. For ESP32-DevKitC devices this is labeled in the
     [functional description diagram](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/hw-reference/esp32/get-started-devkitc.html#functional-description).
 
-          $ idf.py flash monitor ESPPORT=/dev/tty.SLAB_USBtoUART
+          $ idf.py -p /dev/tty.SLAB_USBtoUART flash monitor
 
     Note: Some users might have to install the
     [VCP driver](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
@@ -106,7 +105,7 @@ that are currently supported include `ESP32-DevKitC` (default),
 
 -   If desired, the monitor can be run again like so:
 
-          $ idf.py monitor ESPPORT=/dev/tty.SLAB_USBtoUART
+          $ idf.py -p /dev/tty.SLAB_USBtoUART monitor
 
 ## Commissioning and cluster control
 
@@ -126,7 +125,7 @@ menuconfig).
 2.  Now flash the device with the same command as before. (Use the right `/dev`
     device)
 
-          $ idf.py flash monitor ESPPORT=/dev/tty.SLAB_USBtoUART
+          $ idf.py -p /dev/tty.SLAB_USBtoUART flash monitor
 
 3.  The device should boot up. When device connects to your network, you will
     see a log like this on the device console.
@@ -147,7 +146,7 @@ menuconfig).
 Note: The ESP32 does not support 5GHz networks. Also, the Device will persist
 your network configuration. To erase it, simply run.
 
-          $ idf.py erase_flash ESPPORT=/dev/tty.SLAB_USBtoUART
+          $ idf.py -p /dev/tty.SLAB_USBtoUART erase_flash
 
 ### Setting up Python Controller
 

diff --git a/examples/lock-app/esp32/README.md b/examples/lock-app/esp32/README.md
@@ -30,7 +30,6 @@ step. To install these components manually, follow these steps:
           $ cd esp-idf
           $ git checkout release/v4.2
           $ git submodule update --init
-          $ export IDF_PATH=${HOME}/tools/esp-idf
           $ ./install.sh
 
 -   Install ninja-build
@@ -79,7 +78,7 @@ make sure the IDF_PATH has been exported(See the manual setup steps above).
     before flashing. For ESP32-DevKitC devices this is labeled in the
     [functional description diagram](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/hw-reference/esp32/get-started-devkitc.html#functional-description).
 
-         $ idf.py flash monitor ESPPORT=/dev/tty.SLAB_USBtoUART
+         $ idf.py -p /dev/tty.SLAB_USBtoUART flash monitor
 
     Note: Some users might have to install the
     [VCP driver](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
@@ -92,7 +91,7 @@ make sure the IDF_PATH has been exported(See the manual setup steps above).
 
 -   If desired, the monitor can be run again like so:
 
-          $ idf.py monitor ESPPORT=/dev/tty.SLAB_USBtoUART
+          $ idf.py -p /dev/tty.SLAB_USBtoUART monitor
 
 ## Commissioning and cluster control
 
@@ -112,7 +111,7 @@ menuconfig).
 2.  Now flash the device with the same command as before. (Use the right `/dev`
     device)
 
-          $ idf.py flash monitor ESPPORT=/dev/tty.SLAB_USBtoUART
+          $ idf.py -p /dev/tty.SLAB_USBtoUART flash monitor
 
 3.  The device should boot up. When device connects to your network, you will
     see a log like this on the device console.
@@ -133,7 +132,7 @@ menuconfig).
 Note: The ESP32 does not support 5GHz networks. Also, the Device will persist
 your network configuration. To erase it, simply run.
 
-    $ idf.py erase_flash ESPPORT=/dev/tty.SLAB_USBtoUART
+    $ idf.py -p /dev/tty.SLAB_USBtoUART erase_flash
 
 ### Setting up Python Controller
 

diff --git a/examples/persistent-storage/esp32/README.md b/examples/persistent-storage/esp32/README.md
@@ -49,7 +49,6 @@ step. To install these components manually, follow these steps:
           $ cd esp-idf
           $ git checkout release/v4.2
           $ git submodule update --init
-          $ export IDF_PATH=${HOME}/tools/esp-idf
           $ ./install.sh
 
 -   Install ninja-build
@@ -98,7 +97,7 @@ make sure the IDF_PATH has been exported(See the manual setup steps above).
     before flashing. For ESP32-DevKitC devices this is labeled in the
     [functional description diagram](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/hw-reference/esp32/get-started-devkitc.html#functional-description).
 
-          $ idf.py flash monitor ESPPORT=/dev/tty.SLAB_USBtoUART
+          $ idf.py -p /dev/tty.SLAB_USBtoUART flash monitor
 
     Note: Some users might have to install the
     [VCP driver](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)

diff --git a/examples/pigweed-app/esp32/README.md b/examples/pigweed-app/esp32/README.md
@@ -43,7 +43,6 @@ step. To install these components manually, follow these steps:
           $ cd esp-idf
           $ git checkout release/v4.2
           $ git submodule update --init
-          $ export IDF_PATH=${HOME}/tools/esp-idf
           $ ./install.sh
 
 -   Install ninja-build
@@ -95,7 +94,7 @@ To download and install packages.
     before flashing. For ESP32-DevKitC devices this is labeled in the
     [functional description diagram](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/hw-reference/esp32/get-started-devkitc.html#functional-description).
 
-          $ idf.py build flash ESPPORT=/dev/tty.SLAB_USBtoUART
+          $ idf.py -p /dev/tty.SLAB_USBtoUART build flash
 
     Note: Some users might have to install the
     [VCP driver](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)

diff --git a/examples/temperature-measurement-app/esp32/README.md b/examples/temperature-measurement-app/esp32/README.md
@@ -30,7 +30,6 @@ step. To install these components manually, follow these steps:
           $ cd esp-idf
           $ git checkout release/v4.2
           $ git submodule update --init
-          $ export IDF_PATH=${HOME}/tools/esp-idf
           $ ./install.sh
 
 -   Install ninja-build
@@ -79,7 +78,7 @@ make sure the IDF_PATH has been exported(See the manual setup steps above).
     before flashing. For ESP32-DevKitC devices this is labeled in the
     [functional description diagram](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/hw-reference/esp32/get-started-devkitc.html#functional-description).
 
-          $ idf.py flash monitor ESPPORT=/dev/tty.SLAB_USBtoUART
+          $ idf.py -p /dev/tty.SLAB_USBtoUART flash monitor
 
     Note: Some users might have to install the
     [VCP driver](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
@@ -92,7 +91,7 @@ make sure the IDF_PATH has been exported(See the manual setup steps above).
 
 -   If desired, the monitor can be run again like so:
 
-          $ idf.py monitor ESPPORT=/dev/tty.SLAB_USBtoUART
+          $ idf.py -p /dev/tty.SLAB_USBtoUART monitor
 
 ## Commissioning and cluster control
 
@@ -112,7 +111,7 @@ menuconfig).
 2.  Now flash the device with the same command as before. (Use the right `/dev`
     device)
 
-          $ idf.py flash monitor ESPPORT=/dev/tty.SLAB_USBtoUART
+          $ idf.py -p /dev/tty.SLAB_USBtoUART flash monitor
 
 3.  The device should boot up. When device connects to your network, you will
     see a log like this on the device console.
@@ -133,7 +132,7 @@ menuconfig).
 Note: The ESP32 does not support 5GHz networks. Also, the Device will persist
 your network configuration. To erase it, simply run.
 
-    $ idf.py erase_flash ESPPORT=/dev/tty.SLAB_USBtoUART
+    $ idf.py -p /dev/tty.SLAB_USBtoUART erase_flash
 
 ### Setting up Python Controller
 
@@ -195,5 +194,5 @@ Optimization related to WiFi, BLuetooth, Asserts etc are the part of this
 example by default. To enable this option set is_debug=false from command-line.
 
 ```
-idf.py -Dis_debug=false build flash monitor
+idf.py -p /dev/tty.SLAB_USBtoUART -Dis_debug=false build flash monitor
 ```