Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ESP32: Fixes for README.md #7391

Merged
merged 1 commit into from
Jun 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion examples/all-clusters-app/esp32/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
9 changes: 4 additions & 5 deletions examples/all-clusters-app/esp32/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand All @@ -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

Expand All @@ -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.
Expand All @@ -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

Expand Down
8 changes: 7 additions & 1 deletion examples/all-clusters-app/esp32/main/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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"
Expand All @@ -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"
Expand Down
9 changes: 4 additions & 5 deletions examples/lock-app/esp32/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand All @@ -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

Expand All @@ -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.
Expand All @@ -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

Expand Down
1 change: 0 additions & 1 deletion examples/persistent-storage/esp32/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)
Expand Down
3 changes: 1 addition & 2 deletions examples/persistent-storage/esp32/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down
1 change: 0 additions & 1 deletion examples/persistent-storage/esp32/main/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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}/.."
Expand Down
1 change: 0 additions & 1 deletion examples/pigweed-app/esp32/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)
Expand Down
3 changes: 1 addition & 2 deletions examples/pigweed-app/esp32/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down
1 change: 0 additions & 1 deletion examples/pigweed-app/esp32/main/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
11 changes: 5 additions & 6 deletions examples/temperature-measurement-app/esp32/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand All @@ -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

Expand All @@ -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.
Expand All @@ -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

Expand Down Expand Up @@ -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
```
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down