EOS/DOCS.md

<!--
  DOCS.md is used by Home Assistant for the Add-on Store documentation.
-->

# Akkudoktor-EOS – Home Assistant Add-on Documentation

## Overview

**Akkudoktor-EOS** is a Home Assistant add-on that optimizes household energy flows such as battery storage, photovoltaic (PV) generation, grid usage, and controllable loads.

The add-on is designed to be *practical and user-focused*: once configured, it runs automatically in the background and integrates seamlessly with Home Assistant. Advanced optimization logic and simulations are handled internally — no programming required.

EOS is especially suited for users who:

* Have a home battery and/or PV system
* Want to use forecasts to make smarter energy decisions
* Prefer a transparent, configurable, and locally running solution


## Features

* 🔋 Battery and storage optimization
* ☀️ PV forecast integration
* ⚡ Load and power profile optimization
* 🧠 Forecast-based optimization
* 🧩 Modular simulation and controller architecture
* 🏠 Native Home Assistant add-on integration
* 📊 Designed for extensibility with custom energy devices
-												feat: add Home Assistant and NodeRED adapters (#764)

Adapters for Home Assistant and NodeRED integration are added.
Akkudoktor-EOS can now be run as Home Assistant add-on and standalone.

As Home Assistant add-on EOS uses ingress to fully integrate the EOSdash dashboard
in Home Assistant.

The fix includes several bug fixes that are not directly related to the adapter
implementation but are necessary to keep EOS running properly and to test and
document the changes.

* fix: development version scheme

  The development versioning scheme is adaptet to fit to docker and
  home assistant expectations. The new scheme is x.y.z and x.y.z.dev<hash>.
  Hash is only digits as expected by home assistant. Development version
  is appended by .dev as expected by docker.

* fix: use mean value in interval on resampling for array

  When downsampling data use the mean value of all values within the new
  sampling interval.

* fix: default battery ev soc and appliance wh

  Make the genetic simulation return default values for the
  battery SoC, electric vehicle SoC and appliance load if these
  assets are not used.

* fix: import json string

  Strip outer quotes from JSON strings on import to be compliant to json.loads()
  expectation.

* fix: default interval definition for import data

  Default interval must be defined in lowercase human definition to
  be accepted by pendulum.

* fix: clearoutside schema change

* feat: add adapters for integrations

  Adapters for Home Assistant and NodeRED integration are added.
  Akkudoktor-EOS can now be run as Home Assistant add-on and standalone.

  As Home Assistant add-on EOS uses ingress to fully integrate the EOSdash dashboard
  in Home Assistant.

* feat: allow eos to be started with root permissions and drop priviledges

  Home assistant starts all add-ons with root permissions. Eos now drops
  root permissions if an applicable user is defined by paramter --run_as_user.
  The docker image defines the user eos to be used.

* feat: make eos supervise and monitor EOSdash

  Eos now not only starts EOSdash but also monitors EOSdash during runtime
  and restarts EOSdash on fault. EOSdash logging is captured by EOS
  and forwarded to the EOS log to provide better visibility.

* feat: add duration to string conversion

  Make to_duration to also return the duration as string on request.

* chore: Use info logging to report missing optimization parameters

  In parameter preparation for automatic optimization an error was logged for missing paramters.
  Log is now down using the info level.

* chore: make EOSdash use the EOS data directory for file import/ export

  EOSdash use the EOS data directory for file import/ export by default.
  This allows to use the configuration import/ export function also
  within docker images.

* chore: improve EOSdash config tab display

  Improve display of JSON code and add more forms for config value update.

* chore: make docker image file system layout similar to home assistant

  Only use /data directory for persistent data. This is handled as a
  docker volume. The /data volume is mapped to ~/.local/share/net.akkudoktor.eos
  if using docker compose.

* chore: add home assistant add-on development environment

  Add VSCode devcontainer and task definition for home assistant add-on
  development.

* chore: improve documentation
											
										
										
											2025-12-30 22:08:21 +01:00
+								<!--
 								  DOCS.md is used by Home Assistant for the Add-on Store documentation.
 								-->
 								# Akkudoktor-EOS – Home Assistant Add-on Documentation
 								## Overview
 								**Akkudoktor-EOS** is a Home Assistant add-on that optimizes household energy flows such as battery storage, photovoltaic (PV) generation, grid usage, and controllable loads.
 								The add-on is designed to be *practical and user-focused*: once configured, it runs automatically in the background and integrates seamlessly with Home Assistant. Advanced optimization logic and simulations are handled internally — no programming required.
 								EOS is especially suited for users who:
 								* Have a home battery and/or PV system
 								* Want to use forecasts to make smarter energy decisions
 								* Prefer a transparent, configurable, and locally running solution
 								## Features
 								* 🔋 Battery and storage optimization
 								* ☀️ PV forecast integration
 								* ⚡ Load and power profile optimization
 								* 🧠 Forecast-based optimization
 								* 🧩 Modular simulation and controller architecture
 								* 🏠 Native Home Assistant add-on integration
 								* 📊 Designed for extensibility with custom energy devices