Skip to content

Commit 3014543

Browse files
authored
Add shorthand (#5684)
1 parent b8eaed4 commit 3014543

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

content/components/esp32.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -231,15 +231,39 @@ esp32:
231231

232232
The `components` option allows you to include IDF components. These components will then be compiled into the resulting
233233
firmware and may be used by [lambdas](/automations/templates#config-lambda). The most common usage of this option is to include third-party
234-
components that are available in the [ESP Component Registry](https://components.espressif.com/). They can be added by
235-
listing their name under this option. It is also possible to use specific versions, or to fetch components from a file or
236-
git repository.
234+
components that are available in the [ESP Component Registry](https://components.espressif.com/).
235+
236+
### Simple
237+
238+
For components from the ESP Component Registry, you can use the shorthand syntax `owner/component^version`:
239+
240+
```yaml
241+
esp32:
242+
framework:
243+
components:
244+
- espressif/esp_hosted^2.6.1
245+
```
246+
247+
### Advanced
248+
249+
For more complex configurations (custom git repositories, local paths, etc.), use the advanced syntax:
250+
251+
```yaml
252+
esp32:
253+
framework:
254+
components:
255+
- name: my_custom_component
256+
source: https://github.com/user/component.git
257+
ref: main
258+
path: components/custom
259+
```
260+
261+
#### Configuration Variables
237262

238263
- **name** (*Required*, string): Name of the component e.g. `espressif/esp_hosted`.
239264
- **ref** (*Optional*, string): Component registry version or a git ref.
240265
- **source** (*Optional*, string): The git repository to use for the component. This can be used for a
241266
custom or patched version of the component.
242-
243267
- **path** (*Optional*, string): The path of the component in the git repository or a local path to the
244268
component if `source` is not set.
245269

0 commit comments

Comments
 (0)