From 11175042260413369ff101c28f07d860a8f73452 Mon Sep 17 00:00:00 2001 From: Sweety Date: Fri, 4 Jun 2021 20:45:31 +0530 Subject: [PATCH] ESP32: Fixes for README.md (#7391) --- examples/all-clusters-app/esp32/CMakeLists.txt | 1 - examples/all-clusters-app/esp32/README.md | 9 ++++----- examples/all-clusters-app/esp32/main/CMakeLists.txt | 8 +++++++- examples/lock-app/esp32/README.md | 9 ++++----- examples/persistent-storage/esp32/CMakeLists.txt | 1 - examples/persistent-storage/esp32/README.md | 3 +-- examples/persistent-storage/esp32/main/CMakeLists.txt | 1 - examples/pigweed-app/esp32/CMakeLists.txt | 1 - examples/pigweed-app/esp32/README.md | 3 +-- examples/pigweed-app/esp32/main/CMakeLists.txt | 1 - .../temperature-measurement-app/esp32/CMakeLists.txt | 1 - examples/temperature-measurement-app/esp32/README.md | 11 +++++------ .../esp32/main/CMakeLists.txt | 1 - 13 files changed, 22 insertions(+), 28 deletions(-) diff --git a/examples/all-clusters-app/esp32/CMakeLists.txt b/examples/all-clusters-app/esp32/CMakeLists.txt index f1e501c3c9fa46..71d0e037c7d661 100644 --- a/examples/all-clusters-app/esp32/CMakeLists.txt +++ b/examples/all-clusters-app/esp32/CMakeLists.txt @@ -19,7 +19,6 @@ cmake_minimum_required(VERSION 3.5) include($ENV{IDF_PATH}/tools/cmake/project.cmake) -# The list of extra component dirs must be in sync with that in all-clusters-app/esp32/Makefile set(EXTRA_COMPONENT_DIRS "${CMAKE_CURRENT_LIST_DIR}/third_party/connectedhomeip/config/esp32/components" "${CMAKE_CURRENT_LIST_DIR}/../../common/m5stack-tft/repo/components" diff --git a/examples/all-clusters-app/esp32/README.md b/examples/all-clusters-app/esp32/README.md index 21a1aab460a381..5272c798ea293e 100644 --- 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/all-clusters-app/esp32/main/CMakeLists.txt b/examples/all-clusters-app/esp32/main/CMakeLists.txt index b7a7c49b6227d4..8c2edd7899bb48 100644 --- a/examples/all-clusters-app/esp32/main/CMakeLists.txt +++ b/examples/all-clusters-app/esp32/main/CMakeLists.txt @@ -16,7 +16,6 @@ # # (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.) -# The list of src and include dirs must be in sync with that in all-clusters-app/esp32/main/component.mk idf_component_register(PRIV_INCLUDE_DIRS "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/examples/all-clusters-app/all-clusters-common" "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/third_party/nlio/repo/include" @@ -32,6 +31,9 @@ idf_component_register(PRIV_INCLUDE_DIRS "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/on-off-server" "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/level-control" "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/identify" + "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/account-login-server" + "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/application-launcher-server" + "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/audio-output-server" "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/barrier-control-server" "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/general-commissioning-server" "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/network-commissioning" @@ -40,11 +42,15 @@ idf_component_register(PRIV_INCLUDE_DIRS "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/content-launch-server" "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/operational-credentials-server" "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/trusted-root-certificates-server" + "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/media-input-server" "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/low-power-server" + "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/keypad-input-server" "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/media-playback-server" "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/ota-server" "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/binary-input-server" + "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/target-navigator-server" "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/temperature-measurement-server" + "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/tv-channel-server" "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/scenes" "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/basic" "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/bindings" diff --git a/examples/lock-app/esp32/README.md b/examples/lock-app/esp32/README.md index fb99600fc32752..7068e64ebbe02e 100644 --- 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/CMakeLists.txt b/examples/persistent-storage/esp32/CMakeLists.txt index 54ea09260202b7..7aeda8f641e2e0 100644 --- a/examples/persistent-storage/esp32/CMakeLists.txt +++ b/examples/persistent-storage/esp32/CMakeLists.txt @@ -18,7 +18,6 @@ cmake_minimum_required(VERSION 3.5) include($ENV{IDF_PATH}/tools/cmake/project.cmake) -# The list of extra component dirs must be in sync with that in persistent-storage/esp32/Makefile set(EXTRA_COMPONENT_DIRS "${CMAKE_CURRENT_LIST_DIR}/third_party/connectedhomeip/config/esp32/components" ) diff --git a/examples/persistent-storage/esp32/README.md b/examples/persistent-storage/esp32/README.md index a5ebf45b6a7ffb..a9c15dd1f96caa 100644 --- 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/persistent-storage/esp32/main/CMakeLists.txt b/examples/persistent-storage/esp32/main/CMakeLists.txt index 17494ef83096f3..2a9ad004a2a36c 100644 --- a/examples/persistent-storage/esp32/main/CMakeLists.txt +++ b/examples/persistent-storage/esp32/main/CMakeLists.txt @@ -15,7 +15,6 @@ # limitations under the License. # -# The list of src and include dirs must be in sync with that in persistent-storage/esp32/main/component.mk idf_component_register(PRIV_INCLUDE_DIRS "${CMAKE_CURRENT_LIST_DIR}" "${CMAKE_SOURCE_DIR}/.." diff --git a/examples/pigweed-app/esp32/CMakeLists.txt b/examples/pigweed-app/esp32/CMakeLists.txt index 9d604f9291f4be..0007ceb6a6be10 100644 --- a/examples/pigweed-app/esp32/CMakeLists.txt +++ b/examples/pigweed-app/esp32/CMakeLists.txt @@ -19,7 +19,6 @@ cmake_minimum_required(VERSION 3.5) include($ENV{IDF_PATH}/tools/cmake/project.cmake) -# The list of extra component dirs must be in sync with that in pigweed-app/esp32/Makefile set(EXTRA_COMPONENT_DIRS "${CMAKE_CURRENT_LIST_DIR}/third_party/connectedhomeip/config/esp32/components" ) diff --git a/examples/pigweed-app/esp32/README.md b/examples/pigweed-app/esp32/README.md index 5363eafd06e409..2d4fc6b5c0d5d6 100644 --- 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/pigweed-app/esp32/main/CMakeLists.txt b/examples/pigweed-app/esp32/main/CMakeLists.txt index 002126db9907ff..4f20f49e9d6245 100644 --- a/examples/pigweed-app/esp32/main/CMakeLists.txt +++ b/examples/pigweed-app/esp32/main/CMakeLists.txt @@ -14,7 +14,6 @@ # See the License for the specific language governing permissions and # limitations under the License. -# The list of src and include dirs must be in sync with that in pigweed-app/esp32/main/component.mk idf_component_register(INCLUDE_DIRS "${CMAKE_CURRENT_LIST_DIR}" "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/third_party/pigweed/repo/pw_sys_io/public" diff --git a/examples/temperature-measurement-app/esp32/CMakeLists.txt b/examples/temperature-measurement-app/esp32/CMakeLists.txt index c72b7a3935dd4c..5045aff170f121 100644 --- a/examples/temperature-measurement-app/esp32/CMakeLists.txt +++ b/examples/temperature-measurement-app/esp32/CMakeLists.txt @@ -25,7 +25,6 @@ endif() include($ENV{IDF_PATH}/tools/cmake/project.cmake) -# The list of extra component dirs must be in sync with that in temperature-measurement-app/esp32/Makefile set(EXTRA_COMPONENT_DIRS "${CMAKE_CURRENT_LIST_DIR}/third_party/connectedhomeip/config/esp32/components" "${CMAKE_CURRENT_LIST_DIR}/../../common/m5stack-tft/repo/components" diff --git a/examples/temperature-measurement-app/esp32/README.md b/examples/temperature-measurement-app/esp32/README.md index 21151e1a4ee557..dd6c1fbf6f7e00 100644 --- 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 ``` diff --git a/examples/temperature-measurement-app/esp32/main/CMakeLists.txt b/examples/temperature-measurement-app/esp32/main/CMakeLists.txt index 40721820f6512a..c47ed29a7228b3 100644 --- a/examples/temperature-measurement-app/esp32/main/CMakeLists.txt +++ b/examples/temperature-measurement-app/esp32/main/CMakeLists.txt @@ -16,7 +16,6 @@ # # # (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.) -# The list of src and include dirs must be in sync with that in temperature-measurement-app/esp32/main/component.mk idf_component_register(PRIV_INCLUDE_DIRS "${CMAKE_CURRENT_LIST_DIR}" "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/third_party/nlio/repo/include"