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

[Documentation] [ESP32] ESP-C6 specific configuration in ESP32 Application Usage Guide #26768

Merged
merged 5 commits into from
Jun 27, 2023
Merged
Changes from 1 commit
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
Next Next commit
Update build_app_and_commission.md
Add esp32c6 specific configuration in ESP32 Application Usage Guide
  • Loading branch information
lboue authored and woody-apple committed Jun 27, 2023
commit 633bc3dd50efe3bcb936af61a6233e7763bb0784
23 changes: 13 additions & 10 deletions docs/guides/esp32/build_app_and_commission.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ and the ESP32S3.

All the applications support variants of ESP32, ESP32C3, ESP32S3 chips.

ESP32H2 is only supported and tested with lighting-app.
ESP32H2 and ESP32C6 are only supported and tested with lighting-app and all-clusters-app.

Note: M5Stack Core 2 display is not supported in the tft component, while other
functionality can still work fine.
Expand Down Expand Up @@ -86,23 +86,25 @@ functionality can still work fine.

All the example applications supports target chips: esp32, esp32s3, esp32c3

ESP32H2 is only supported in lighting-app, to set it as target
ESP32H2 and ESP32C6 are only supported in lighting-app, to set it as target

```
idf.py --preview set-target esp32h2
$ idf.py --preview set-target esp32h2
$ idf.py --preview set-target esp32c6
```

- Configuration Options

To build the default configuration (`sdkconfig.defaults`) skip this step.

To build a specific configuration (example `m5stack`):
To build a specific configuration (example `m5stack` or `esp32h2` or `esp32c6`):

```
$ rm sdkconfig
$ idf.py -D 'SDKCONFIG_DEFAULTS=sdkconfig_m5stack.defaults' build
$ idf.py -D 'SDKCONFIG_DEFAULTS=sdkconfig.defaults.esp32h2' build
woody-apple marked this conversation as resolved.
Show resolved Hide resolved
$ idf.py -D 'SDKCONFIG_DEFAULTS=sdkconfig.defaults.esp32c6' build
```

Note: If using a specific device configuration, it is highly recommended to
start off with one of the defaults and customize on top of that. Certain
configurations have different constraints that are customized within the
Expand All @@ -117,7 +119,7 @@ functionality can still work fine.
- Build the application

```
idf.py build
$ idf.py build
```

- Flash the application
Expand Down Expand Up @@ -158,14 +160,14 @@ Below apps can be used for commissioning the application running on ESP32:
### Building Standalone chip-tool

```
cd path/to/connectedhomeip
scripts/examples/gn_build_example.sh examples/chip-tool out/debug
$ cd path/to/connectedhomeip
$ scripts/examples/gn_build_example.sh examples/chip-tool out/debug
```

Run the built executable and pass it the discriminator and pairing code of the
remote device, as well as the network credentials to use.

#### Commissioning the WiFi devices (ESP32, ESP32C3, ESP32S3)
#### Commissioning the WiFi devices (ESP32, ESP32C3, ESP32S3, ESP32C6)

```
$ out/debug/chip-tool pairing ble-wifi 12345 MY_SSID MY_PASSWORD 20202021 3840
Expand All @@ -187,7 +189,7 @@ $ out/debug/chip-tool pairing ble-wifi 12345 MY_SSID MY_PASSWORD 20202021 3840
- Commissioning the Thread device

```
$ ./out/debug/chip-tool pairing ble-thread 12345 hex:<operational-dataset> 20202021 3840
$ ./out/debug/chip-tool pairing ble-thread 12345 hex:<operational-dataset> 20202021 3840
```

#### Commissioning the Ethernet device (ESP32-Ethernet-Kit)
Expand Down Expand Up @@ -222,6 +224,7 @@ follow [Using ESP32 Factory Data Provider guide](factory_data.md)
```
$ idf.py set-target esp32
$ idf.py set-target esp32c3
$ idf.py set-target esp32c6
```

- Execute below sequence of commands
Expand Down