https://github.com/davet2001/elec-sankey

A webcomponent to create sankey diagrams (typically for domestic electricity flow).
https://github.com/davet2001/elec-sankey

Last synced: 14 days ago
JSON representation

A webcomponent to create sankey diagrams (typically for domestic electricity flow).

• Host: GitHub
• URL: https://github.com/davet2001/elec-sankey
• Owner: davet2001
• License: mit
• Created: 2024-05-08T19:39:47.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-05-08T23:07:27.000Z (8 months ago)
• Last Synced: 2024-12-14T03:36:28.360Z (23 days ago)
• Language: JavaScript
• Size: 63.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# elec-sankey

A webcomponent to create sankey diagrams (typically for domestic electricity flow).

*This is an early version - currently experimental!*

This is also my first foray into creating a webcomponent, and not long after learning typescript. As a result: improvements/suggestions/PRs welcome!

## Key Features:

 - Configurable units

 - Configurable text

 - Configurable icons

 - Dynamic updates when used in the LitElement framework

 - Configurable colours

 - Label creation is basic but intended to be overridden by the subclass, e.g. to make labels clickable for more information.

## Example:

Example of this component styled within [Home Assistant](https://www.home-assistant.io/):

![image](https://github.com/davet2001/elec-sankey/assets/17680170/31eea146-c88a-4c10-900d-2aa1295aab5c)

## Design:

In general, the aim of this class is to display a coherent and informative visual representation of the flow of electricity. If a strange occurence occurs, such as consumption exceeding total input power, the class should attempt to display a sensible visual, including phantom sources or consumers to convey a complete diagram.

The reason for this is that the class is likely to receive asynchronous updates from different sensors. It must display a glitch-free best approximation of the reality until more information becomes available.

Internally, the class deliberately avoids making reference to power or energy because it can be used for either. By populating with power (W) values it represents power flow. By populating with energy (kWh) values it represents the energy flow over a period of time. 'rate' is used as a generic variable name that can be power/energy.

## Architecture note:

While written for home assistant, this class deliberately makes no reference to HA and is decoupled from it. It is designed to be subclassed within HA.