Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eulemitkeule/estimenergy

EstimEnergy is tool for monitoring and estimating energy usage and cost built with FastAPI and Angular.
https://github.com/eulemitkeule/estimenergy

angular energy energy-calculator energy-consumption estimenergy fastapi home-assistant home-assistant-glow python

Last synced: 6 days ago
JSON representation

EstimEnergy is tool for monitoring and estimating energy usage and cost built with FastAPI and Angular.

Host: GitHub
URL: https://github.com/eulemitkeule/estimenergy
Owner: EuleMitKeule
License: mit
Created: 2023-02-23T18:36:44.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2023-05-19T07:19:45.000Z (over 1 year ago)
Last Synced: 2024-04-29T08:43:33.222Z (5 months ago)
Topics: angular, energy, energy-calculator, energy-consumption, estimenergy, fastapi, home-assistant, home-assistant-glow, python
Language: Python
Homepage:
Size: 434 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

[![PyPI](https://img.shields.io/pypi/v/estimenergy)](https://pypi.org/project/estimenergy)
[![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg)](https://github.com/hacs/integration)

[![Publish](https://github.com/EuleMitKeule/EstimEnergy/actions/workflows/publish.yml/badge.svg)](https://github.com/EuleMitKeule/EstimEnergy/actions/workflows/publish.yml)
[![Code Quality](https://github.com/EuleMitKeule/EstimEnergy/actions/workflows/quality.yml/badge.svg)](https://github.com/EuleMitKeule/EstimEnergy/actions/workflows/quality.yml)

# EstimEnergy

EstimEnergy is tool for monitoring and estimating energy usage and cost.
It consists of a FastAPI backend that collects data from a device, an Angular frontend for configuration and a HACS enabled custom integration for Home Assistant that exposes the data via a sensor entity.

## Installation

Create the following directories:

`/path/to/appdata/estimenergy/config`

`/path/to/appdata/estimenergy/postgresql`

`/path/to/appdata/estimenergy/influxdb`

`/path/to/appdata/estimenergy/prometheus`

Create a configuration file named `config.yml` in the config directory.

```yaml
db:
url: "postgresql://estimenergy:@estimenergy-postgresql:5432/estimenergy?sslmode=disable"

influxdb:
url: http://estimenergy-influxdb:8086
org: estimenergy
token:
bucket: estimenergy
```

Now you can deploy the application stack using the example [docker-compose](docker-compose.yml) configuration.
Add mounting paths according to where you created the corresponding directories.

Using InfluxDB and Prometheus is optional. If you don't want to use InfluxDB, you need to remove the configuration from the `config.yml` file.

Postgres is also optional and can be replaced with any other SQL database including SQLite. If you want to use SQLite, you need to change to database URL in the config file to `sqlite:////config/estimenergy.db`. Using an external database is recommended, since the Grafana dashboard needs to access the database directly.

```yaml
# docker-compose

services:
estimenergy:
# ...
volumes:
- /path/to/appdata/estimenergy/config:/config

estimenergy-postgresql:
# ...
volumes:
- /path/to/appdata/estimenergy/postgresql:/var/lib/postgresql/data

estimenergy-influxdb:
# ...
volumes:
- /path/to/appdata/estimenergy/influxdb:/var/lib/influxdb2

estimenergy-prometheus:
# ...
volumes:
- /path/to/appdata/estimenergy/prometheus:/prometheus
```

Now you should have EstimEnergy running on port `12321`, a prometheus collector running at port `9090`, InfluxDB at port `8086` and PostgreSQL at port `5432`.

Prometheus will scrape the metrics exposed by EstimEnergy every 15 seconds and keep the data for five years or until 1TB of space is used. This can be configured using the `--storage.tsdb.retention.time` and `--storage.tsdb.retention.size` command options in the docker-compose file.

You should now be able to access the web UI at port 12321. You will have to create one or more devices and configure them using your energy contract data.

## Home Assistant Integration

Install the repository in HACS via the custom repository option. After restarting Home Assistant you can add and configure the integration in the integrations UI. You need to provide the hostname or IP of the EstimEnergy docker container and the port on which it is running on.

This will create sensor entities for each collector and each metric that is being collected. You can use the `Total Energy` and `Total Cost` entities as data sources for the Home Assistant Energy Dashboard.

## Specification