Skip to content

Commit

Permalink
Add installation instructions and badges
Browse files Browse the repository at this point in the history
  • Loading branch information
davet2001 authored Oct 30, 2024
1 parent 16d6d28 commit ae09069
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
[![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg?style=for-the-badge)](https://github.com/hacs/integration)

# Energy Sankey
# Home Assistant Energy Sankey

[![GitHub Release][releases-shield]][releases]
[![hacs_badge](https://img.shields.io/badge/HACS-Default-41BDF5.svg?style=for-the-badge)](https://github.com/hacs/integration)
[![License][license-shield]](LICENSE.md)


Energy Sankey is a collection of dashboard cards for homeassistant, dynamically displaying the flow of electrical energy and power.

![alt text](image.png)

The cards are ideal if you want to track your energy consumption and identify where your energy is going.

The aim is for as easy setup as possible. No configuring groups of child entities, complicated choices or hunting for info to populate a yaml configuration.
The aim is for as easy setup as possible. No configuring groups of child entities, complicated choices or hunting for info to populate a yaml configuration. In most cases, the default configuration should just work.

There are two main cards:
- a card showing the total _energy_ flow based on a configurable* time range (e.g. day so far).
Expand All @@ -24,6 +28,15 @@ The colour of the flows heading to the consumers represents the blend of locally

The diagram dynamically scales to fit the size of the window it is in (mostly).

# Installation
- Open HACS and search for Energy Sankey
- Click on the repository and select download
- Reload when prompted
- Select a dashboard and enter editing mode
- Type 'Sankey' in the search box
- Select 'Custom: Sankey Energy Flow Card' or 'Custom: Sakney Power Flow Card'
- The energy card does not require configuration
- The power card auto configures. If there are any problems with autoconfiguration, edit the displayed yaml to select the correct power entities for grid input / generation / consumers.

Outstanding issues to solve:
- [ ] Sometimes there are thin dark lines between the blocks that make up the shapes, I believe this is caused by antialiasing, but I don't see an easy way of reducing/eliminating it, especially where the shapes are across two divs.
Expand All @@ -32,3 +45,7 @@ Outstanding issues to solve:


- [ ] Battery storage is not supported yet. That could be added in the future.

[license-shield]: https://img.shields.io/github/license/davet2001/homeassistant-energy-sankey-card.svg?style=for-the-badge
[releases-shield]: https://img.shields.io/github/release/davet2001/homeassistant-energy-sankey-card?style=for-the-badge
[releases]: https://github.com/davet2001/homeassistant-energy-sankey-card/releases

0 comments on commit ae09069

Please sign in to comment.