@@ -82,18 +82,27 @@ esp32:
8282
8383- **version** (*Optional*, string): The base framework version number to use, from
8484 [ESP32 ESP-IDF releases](https://github.com/espressif/esp-idf/releases) or
85- [ESP32 arduino releases](https://github.com/espressif/arduino-esp32/releases). Defaults to `recommended`.
85+ [ESP32 Arduino releases](https://github.com/espressif/arduino-esp32/releases). Defaults to `recommended`.
8686 Additional values are :
8787
8888 - `dev` : Use the latest commit, note this may break at any time
8989 - `latest` : Use the latest *release*, even if it hasn't been recommended yet.
9090 - `recommended` : Use the recommended framework version.
9191
92- - **source** (*Optional*, string): The PlatformIO package or repository to use for the framework. This can be used to
93- use a custom or patched version of the framework.
92+ - **source** (*Optional*, string): The PlatformIO package to use for the framework. This variable provides
93+ the URL of the git repository or file archive of a custom or patched version of the
94+ [pioarduino/framework-arduinoespressif32](https://github.com/espressif/arduino-esp32) or
95+ [pioarduino/framework-espidf](https://github.com/pioarduino/esp-idf) package for the framework type. Refer to
96+ [PlatformIO package specifications](https://docs.platformio.org/en/latest/core/userguide/pkg/cmd_install.html#package-specifications)
97+ for the supported URL schemes. Examples :
98+
99+ - ` https://github.com/user/arduino-esp32/releases/download/archive.zip`
100+ - ` https://github.com/user/esp-idf.git#branch`
101+ - ` symlink:///path/to/esp-idf`
94102
95103- **platform_version** (*Optional*, string): The version of the
96- [pioarduino/espressif32](https://github.com/pioarduino/platform-espressif32/releases/) package to use.
104+ [pioarduino/espressif32](https://github.com/pioarduino/platform-espressif32/releases/) package to use. For known framework versions
105+ this value will be set automatically.
97106
98107- **sdkconfig_options** (*Optional*, mapping): Custom sdkconfig
99108 [compiler options](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/kconfig.html#compiler-options)
0 commit comments