Skip to content

Commit 278f646

Browse files
bramkragtenfrenck
authored andcommitted
Update lovelace ID status + include and secret support (home-assistant#7395)
* Revert automatic lovelace IDs * Add notes about include and secrets * Add config splitting note
1 parent 5af948e commit 278f646

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

source/lovelace/index.markdown

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ excluded_entities:
8484
views:
8585
# View tab title.
8686
- title: Example
87-
# Unique id for direct access /lovelace/${id}. If you don't specify one, it is added automatically.
87+
# Unique id for direct access /lovelace/${id} and editing it from the UI.
8888
id: example
8989
# Optional background (overwrites the global background).
9090
background: radial-gradient(crimson, skyblue)
@@ -93,7 +93,7 @@ views:
9393
# The cards to show on this view.
9494
cards:
9595
# The filter card will filter entities for their state
96-
- id: peoplehome # Every card needs an ID, if you don't specify one, it is added automatically.
96+
- id: peoplehome # Every card needs an ID, for it to be edited from the UI.
9797
type: entity-filter
9898
entities:
9999
- device_tracker.paulus
@@ -137,7 +137,10 @@ views:
137137
Now restart Home Assistant, navigate to `<YOUR HASS URL>/lovelace`. When you make changes to `ui-lovelace.yaml`, you don't have to restart Home Assistant or refresh the page. Just hit the refresh button at the top of the UI.
138138

139139
## {% linkable_title IDs for cards and views %}
140-
Every card and view needs an ID, this is used to edit your config from the UI. If you don't specify an ID, Home Assistant will add one. If you don't want Home Assistant to write to your `ui-lovelace.yaml` file, make sure every view and card have an ID.
140+
If you want to edit your views and cards from the UI, every card and view needs an ID. This ID is used to save your config from the UI.
141+
142+
## {% linkable_title Configuration splitting %}
143+
`ui-lovelace.yaml` only supports basic configuration splitting. Only `!include` and `!secret` are supported, be aware that content that is included with `!include` and `!secret` can not be edited from the UI.
141144

142145
## {% linkable_title Setting Lovelace as the Default UI %}
143146
Once you are ready to start using Lovelace UI as your main user interface, click on info, the "i" icon under 'Developer Tools" in the Home Assistant side-bar. Next, locate >>Set Lovelace as default page on this device<< under the Home Assistant version information and click it.
@@ -174,3 +177,7 @@ frontend:
174177
Given examples refer to `/local/example_image.jpg`. That means you should have `www` directory next to your HA `configuration.yaml`. An image kept in `HA_configuration_dir/www/example_image.jpg` will be shown after refreshing Lovelace page.
175178

176179
Restart Home Assistant after creating the `www` directory. Otherwise, HA will not know that you created this directory.
180+
181+
### {% linkable_title My `ui-lovelace.yaml` file suddenly has ID's added to all cards and views! %}
182+
183+
In version 0.81.0 we started preparing for the ability to edit you Lovelace UI from the UI itself. To be able to do this every view and card should have a unique ID. If your cards or views didn't had an ID, Home Assistant would add a random one. This behaviour was changed in 0.81.1, Home Assistant will no longer change your configuration without asking first. You can edit the generated ID, the only restriction is that it is unique. You could even delete the IDs if you don't want to use the UI edit functionality.

source/lovelace/tips.markdown

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,11 @@ you with the ability to split your Lovelace configuration into multiple files.
3636
The [Lovelace Jinja2 Script][lovelace-jinja] by [@skalavala] is a simple Jinja2 script that you run in the template editor to generate lovelace configuration based on the entities that are already setup.
3737

3838
<p class='note'>
39-
Split configuration is no longer possible in Lovelace since version 0.81, due to the fact that Home Assistant
39+
Lovelace only has limited file splitting functionality, due to the fact that Home Assistant
4040
will be writing directly to the `ui-lovelace.yaml` file.
4141

42+
Only `!include` and `!secret` are supported at the moment.
43+
4244
If you want to split your configuration you can use one of the tools listed above, but edits done with the UI will
4345
be overwritten by those tools, so you should not use both.
4446
</p>

0 commit comments

Comments
 (0)