Skip to content

Commit 5479599

Browse files
Add Power Sankey graph documentation (home-assistant#41819)
Co-authored-by: c0ffeeca7 <[email protected]>
1 parent 1baf59e commit 5479599

File tree

1 file changed

+61
-2
lines changed

1 file changed

+61
-2
lines changed

source/_dashboards/energy.markdown

Lines changed: 61 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,6 @@ link_dashboard: true
121121
The energy sources table card shows all your energy sources, and the corresponding amount of energy.
122122
If setup, it will also show the costs and compensation per source and the total.
123123

124-
125124
### YAML configuration
126125

127126
The following YAML options are available
@@ -328,13 +327,73 @@ type: energy-sankey
328327
layout: vertical
329328
```
330329

331-
## Using Multiple Collections
330+
## Power Sankey graph to visualize power flow
331+
332+
<p class='img'>
333+
<img src='/images/dashboards/energy/sankey.png' alt='Screenshot of the Sankey graph card to visualize power'>
334+
Screenshot of the power Sankey graph card.
335+
</p>
336+
337+
The power Sankey graph shows the real-time flow of power in your home. Unlike the energy Sankey card, which shows historical energy data based on the selected date range, this card displays current power values and is not affected by the date picker selection.
338+
339+
It visualizes the instantaneous power flow from sources (like the grid, solar panels, and battery) to consumers in your home. Devices are grouped into floors and areas if these are configured.
340+
341+
### YAML configuration
342+
343+
The following YAML options are available
344+
345+
{% configuration %}
346+
type:
347+
required: true
348+
description: "`power-sankey`"
349+
type: string
350+
collection_key:
351+
required: false
352+
description: "Collection key to use for the card. This links the card to a specific energy dashboard collection. Defaults to `energy_dashboard`."
353+
type: string
354+
default: energy_dashboard
355+
title:
356+
required: false
357+
description: The title of the card.
358+
type: string
359+
layout:
360+
required: false
361+
description: "`vertical`, `horizontal` or `auto`. Determines the orientation (flow direction) of the card. `auto` changes it based on the screen size."
362+
type: string
363+
default: auto
364+
group_by_area:
365+
required: false
366+
description: Whether to group the devices by area
367+
type: boolean
368+
default: true
369+
group_by_floor:
370+
required: false
371+
description: Whether to group the devices by floor
372+
type: boolean
373+
default: true
374+
{% endconfiguration %}
375+
376+
### Examples
377+
378+
```yaml
379+
type: power-sankey
380+
```
381+
382+
The following example orients the flow from left to right:
383+
384+
```yaml
385+
type: power-sankey
386+
layout: horizontal
387+
```
388+
389+
## Using multiple collections
332390

333391
By default, all energy cards are linked to any `energy-date-selection` card on the view, and all `energy-date-selection` cards are linked to the same period. To enable multiple different date selections on the same view, it is necessary to link them to different collections. This is done by adding the variable `collection_key` to the card YAML, and giving this a value of any custom string that begins with `energy_`. (strings that do not start with `energy_` will generate an error).
334392

335393
All energy cards support use of `collection_key` option.
336394

337395
### Examples
396+
338397
Example view with multiple collections:
339398

340399
```yaml

0 commit comments

Comments
 (0)