esp-idf/examples/common_components/env_caps
laokaiyao d0a8f3e5c4 feat(esp32c5): support esptool on esp32c5 beta3 2024-01-09 13:11:11 +08:00
..
esp32
esp32c2
esp32c3
esp32c5 feat(esp32c5): support esptool on esp32c5 beta3 2024-01-09 13:11:11 +08:00
esp32c6
esp32h2 ESP32H2: Introduce new chip target esp32h2, hello_world example supported 2022-12-29 12:29:14 +08:00
esp32p4 change(header): modify p4 headers issues from check_header_py 2023-08-04 14:13:59 +02:00
esp32s2
esp32s3
linux lwip: Support for linux target 2023-01-31 08:43:45 +01:00
README.md Fix typo in common components example docs 2023-03-23 19:56:58 -04:00

README.md

Examples Environmental Capabilities

Examples environmental related capabilities files are describing the attributes which may be considered common among example projects.

It may include but it is not limited to the following:

  • SoC features like maximum/minimum values, available resources, etc. which are not captured in associated soc_caps.h and there is some reason they cannot be added to soc_caps.h. For example, feature definition is not generic enough and is more related to examples use case or it is just some kind of approximation which is good enough for examples but not for SoC drivers.
  • Various system configuration.
  • Espressif's official development boards features.

How to use

  • Update the Environmental Capabilities Kconfig with capabilities you consider could be shared among other example projects.

  • Use orsource statement in your example project Kconfig to include the Environmental Capabilities as shown below.

orsource "$IDF_PATH/examples/common_components/env_caps/$IDF_TARGET/Kconfig.env_caps"