alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
7c68b67295
esp-idf/examples/common_components/env_caps
History
Hsuan-Ting Lu 9a890137c1
Fix typo in common components example docs
2023-03-23 19:56:58 -04:00
..
esp32 Examples: common source for GPIO range in Kconfigs defined 2022-05-12 09:33:40 +02:00
esp32c2 examples: update max GPIO range for C2 examples to exclude UART0 pins 2022-11-14 10:13:42 +08:00
esp32c3 Examples: common source for GPIO range in Kconfigs defined 2022-05-12 09:33:40 +02:00
esp32c6 esp32c6: add minimal ci support 2022-09-26 20:32:13 +08:00
esp32h2 ESP32H2: Introduce new chip target esp32h2, hello_world example supported 2022-12-29 12:29:14 +08:00
esp32h4 esp32h2: renaming esp32h2 to esp32h4 2022-11-08 17:05:33 +08:00
esp32s2 Examples: common source for GPIO range in Kconfigs defined 2022-05-12 09:33:40 +02:00
esp32s3 Examples: common source for GPIO range in Kconfigs defined 2022-05-12 09:33:40 +02:00
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"