Skip to content

Commit

Permalink
Update all_clusters_app README (#14863)
Browse files Browse the repository at this point in the history
The instructions currently customize the device via menuconfig.
This bypasses the various customizations from the device specific
defaults.

Add a section to encourage users to start with the device specific
defaults to avoid running into hard to debug run-time issues.
  • Loading branch information
dnicoara authored and pull[bot] committed Feb 7, 2024
1 parent 59a1e50 commit 3189062
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion examples/all-clusters-app/esp32/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,20 @@ To set IDF target, run set-target with one of the commands.

- Configuration Options

To choose from the different configuration options, run menuconfig.
To build the default configuration (`sdkconfig.defaults`) skip to building the
demo application.

To build a specific configuration (as an example `m5stack`):

$ rm sdkconfig
$ idf.py -D 'SDKCONFIG_DEFAULTS=sdkconfig_m5stack.defaults' 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
device specific configuration (eg: main app stack size).

To customize the configuration, run menuconfig.

$ idf.py menuconfig

Expand Down

0 comments on commit 3189062

Please sign in to comment.