mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2026-01-01 00:06:18 +00:00
58d70e417b
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
204 lines
6.2 KiB
Markdown
204 lines
6.2 KiB
Markdown
|
|
|
|
|
|
**Build optimized energy management plans for your home automation**
|
|
|
|
AkkudoktorEOS is a comprehensive solution for simulating and optimizing energy systems based on
|
|
renewable sources. Optimize your photovoltaic systems, battery storage, load management, and
|
|
electric vehicles while considering real-time electricity pricing.
|
|
|
|
## Why use AkkudoktorEOS?
|
|
|
|
AkkudoktorEOS can be used to build energy management plans that are optimized for your specific
|
|
setup of PV system, battery, electric vehicle, household load and electricity pricing. It can
|
|
be integrated into home automation systems such as NodeRED, Home Assistant, EVCC.
|
|
|
|
## 🏘️ Community
|
|
|
|
We are an open-source community-driven project and we love to hear from you. Here are some ways to
|
|
get involved:
|
|
|
|
- [GitHub Issue Tracker](https://github.com/Akkudoktor-EOS/EOS/issues): discuss ideas and features,
|
|
and report bugs.
|
|
|
|
- [Akkudoktor Forum](https://www.akkudoktor.net/c/der-akkudoktor/eos): get direct suppport from the
|
|
cummunity.
|
|
|
|
## What do people build with AkkudoktorEOS
|
|
|
|
The community uses AkkudoktorEOS to minimize grid energy consumption and to maximize the revenue
|
|
from grid energy feed in with their home automation system.
|
|
|
|
- Andreas Schmitz, [the Akkudoktor](https://www.youtube.com/@Akkudoktor), uses
|
|
EOS integrated in his NodeRED home automation system for
|
|
[OpenSource Energieoptimierung](https://www.youtube.com/watch?v=sHtv0JCxAYk).
|
|
- Jörg, [meintechblog](https://www.youtube.com/@meintechblog), uses EOS for
|
|
day-ahead optimization for time-variable energy prices. See:
|
|
[So installiere ich EOS von Andreas Schmitz](https://www.youtube.com/watch?v=9XCPNU9UqSs)
|
|
|
|
## Why not use AkkudoktorEOS?
|
|
|
|
AkkudoktorEOS does not control your home automation assets. It must be integrated into a home
|
|
automation system. If you do not use a home automation system or you feel uncomfortable with
|
|
the configuration effort needed for the integration you should better use other solutions.
|
|
|
|
## Quick Start
|
|
|
|
Run EOS with Docker (access dashboard at `http://localhost:8504`):
|
|
|
|
```bash
|
|
docker run -d \
|
|
--name akkudoktoreos \
|
|
-p 8503:8503 \
|
|
-p 8504:8504 \
|
|
-e OPENBLAS_NUM_THREADS=1 \
|
|
-e OMP_NUM_THREADS=1 \
|
|
-e MKL_NUM_THREADS=1 \
|
|
-e EOS_SERVER__HOST=0.0.0.0 \
|
|
-e EOS_SERVER__EOSDASH_HOST=0.0.0.0 \
|
|
-e EOS_SERVER__EOSDASH_PORT=8504 \
|
|
--ulimit nproc=65535:65535 \
|
|
--ulimit nofile=65535:65535 \
|
|
--security-opt seccomp=unconfined \
|
|
akkudoktor/eos:latest
|
|
```
|
|
|
|
## System Requirements
|
|
|
|
- **Python**: 3.11 or higher
|
|
- **Architecture**: amd64, aarch64 (armv8)
|
|
- **OS**: Linux, Windows, macOS
|
|
|
|
> **Note**: Other architectures (armv6, armv7) require manual compilation of dependencies with Rust and GCC.
|
|
|
|
## Installation
|
|
|
|
### Home Assistant add-on
|
|
|
|
![Supports aarch64 Architecture][aarch64-shield]
|
|
![Supports amd64 Architecture][amd64-shield]
|
|
|
|
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
|
|
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
|
|
|
|
To install the **Akkudoktor-EOS** add-on in Home Assistant:
|
|
|
|
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2FAkkudoktor-EOS%2FEOS)
|
|
|
|
1. **Add the repository URL**:
|
|
|
|
In Home Assistant, go to:
|
|
|
|
```
|
|
Settings → Add-ons → Add-on Store → ⋮ (top-right menu) → Repositories
|
|
```
|
|
|
|
and enter the URL of this Git repository:
|
|
|
|
```
|
|
https://github.com/Akkudoktor-EOS/EOS
|
|
```
|
|
|
|
2. **Install the add-on**:
|
|
|
|
After adding the repository, the add-on will appear in the Add-on Store. Click **Install**.
|
|
|
|
3. **Start the add-on**:
|
|
|
|
Once installed, click **Start** in the add-on panel.
|
|
|
|
4. **Access the dashboard**:
|
|
|
|
Click **Open Web UI** in the add-on panel.
|
|
|
|
5. **Configure EOS** (optional):
|
|
In the dashboard, go to:
|
|
|
|
```
|
|
Config
|
|
```
|
|
|
|
### Docker (Recommended)
|
|
|
|
```bash
|
|
docker pull akkudoktor/eos:latest
|
|
docker compose up -d
|
|
```
|
|
|
|
Access the API at `http://localhost:8503` (docs at `http://localhost:8503/docs`)
|
|
|
|
### From Source
|
|
|
|
```bash
|
|
git clone https://github.com/Akkudoktor-EOS/EOS.git
|
|
cd EOS
|
|
```
|
|
|
|
**Linux:**
|
|
|
|
```bash
|
|
python -m venv .venv
|
|
.venv/bin/pip install -r requirements.txt
|
|
.venv/bin/pip install -e .
|
|
.venv/bin/python -m akkudoktoreos.server.eos
|
|
```
|
|
|
|
**Windows:**
|
|
|
|
```cmd
|
|
python -m venv .venv
|
|
.venv\Scripts\pip install -r requirements.txt
|
|
.venv\Scripts\pip install -e .
|
|
.venv\Scripts\python -m akkudoktoreos.server.eos
|
|
```
|
|
|
|
## Configuration
|
|
|
|
EOS uses `EOS.config.json` for configuration. If the file doesn't exist, a default configuration is
|
|
created automatically.
|
|
|
|
### Custom Configuration Directory
|
|
|
|
```bash
|
|
export EOS_DIR=/path/to/your/config
|
|
```
|
|
|
|
### Configuration Methods
|
|
|
|
1. **EOSdash** (Recommended) - Web interface at `http://localhost:8504`
|
|
2. **Manual** - Edit `EOS.config.json` directly
|
|
3. **API** - Use the [Server API](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json)
|
|
|
|
See the [documentation](https://akkudoktor-eos.readthedocs.io/) for all configuration options.
|
|
|
|
## Port Configuration
|
|
|
|
**Default ports**: 8503 (API), 8504 (Dashboard)
|
|
|
|
If running on shared systems (e.g., Synology NAS), these ports may conflict with system services. Reconfigure port mappings as needed:
|
|
|
|
```bash
|
|
docker run -p 8505:8503 -p 8506:8504 ...
|
|
```
|
|
|
|
## API Documentation
|
|
|
|
Interactive API docs available at:
|
|
- Swagger UI: `http://localhost:8503/docs`
|
|
- OpenAPI Spec: [View Online](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json)
|
|
|
|
## Resources
|
|
|
|
- [Full Documentation](https://akkudoktor-eos.readthedocs.io/)
|
|
- [Installation Guide (German)](https://www.youtube.com/watch?v=9XCPNU9UqSs)
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions! See [CONTRIBUTING](CONTRIBUTING.md) for guidelines.
|
|
|
|
[](https://github.com/Akkudoktor-EOS/EOS/graphs/contributors)
|
|
|
|
## License
|
|
|
|
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
|