Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md: added explanation about entities being templatable #147

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md: added explanation about entities being templatable #147

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ resources:
| Name | Type | Requirement | Description |
| --------- | ------ | ------------ | ---------------------------------------------------------------------------------------------------------------- |
| type | string | **Required** | `custom:config-template-card` |
| entities | list | **Required** | List of entity strings that should be watched for updates. Templates can be used here |
| entities | list | **Required** | List of entity strings that should be watched for updates. Templates can be used here for each individual entity, not for generation of the whole entities list. |
| variables | list | **Optional** | List of variables, which can be templates, that can be used in your `config` and indexed using `vars` or by name |
| card | object | **Optional** | Card configuration. (A card, row, or element configuaration must be provided) |
| row | object | **Optional** | Row configuration. (A card, row, or element configuaration must be provided) |
Expand Down Expand Up @@ -84,6 +84,11 @@ card:

### Templated entities example

Each individual entity id can be generated using a template.

Templating the whole `entities` key **is not** possible!
In other words, you cannot generate the list of entities dynamically with a template.

```yaml
type: 'custom:config-template-card'
variables:
Expand Down