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
110 lines
2.5 KiB
Markdown
110 lines
2.5 KiB
Markdown
% SPDX-License-Identifier: Apache-2.0
|
|
(update-page)=
|
|
|
|
# Update Guide
|
|
|
|
This guide explains how to update AkkudoktorEOS to a newer version.
|
|
|
|
- Updating from Source (M1)
|
|
- Updating from Release Package (M2)
|
|
- Updating Docker Installation (M3)
|
|
- Updating Docker Compose Installation (M4)
|
|
- Updating Home Assistant Add-on Installation (M5)
|
|
|
|
Choose the section based on how you originally [installed EOS](install-page).
|
|
|
|
:::{admonition} Tip
|
|
:class: Note
|
|
If you need to revert instead, see the see the [Revert Guideline](revert-page).
|
|
:::
|
|
|
|
## Updating from Source (M1)
|
|
|
|
```{eval-rst}
|
|
.. tabs::
|
|
|
|
.. tab:: Windows
|
|
|
|
.. code-block:: powershell
|
|
|
|
git pull origin main
|
|
.venv\Scripts\pip install -r requirements.txt --upgrade
|
|
|
|
.. tab:: Linux
|
|
|
|
.. code-block:: bash
|
|
|
|
git pull origin main
|
|
.venv/bin/pip install -r requirements.txt --upgrade
|
|
```
|
|
|
|
Restart EOS normally.
|
|
|
|
## Updating from Release Package (M2)
|
|
|
|
1. Download new release
|
|
2. Extract to a new directory
|
|
3. Recreate virtual environment & reinstall dependencies
|
|
4. Optionally remove previous directory
|
|
|
|
Follow steps from [Installation from Release Package (GitHub) (M2)](install-page).
|
|
|
|
## Updating Docker Installation (M3)
|
|
|
|
```bash
|
|
docker pull akkudoktor/eos:latest
|
|
docker stop akkudoktoreos
|
|
docker rm akkudoktoreos
|
|
```
|
|
|
|
Then start the container again using your normal `docker run` command.
|
|
|
|
## Updating Docker Compose Installation (M4)
|
|
|
|
1. Stop & remove existing container
|
|
|
|
```bash
|
|
docker stop akkudoktoreos
|
|
docker rm akkudoktoreos
|
|
```
|
|
|
|
2. Update source (if using source checkout) — see M1 or M2
|
|
3. Rebuild & start
|
|
|
|
```bash
|
|
docker compose up --build
|
|
```
|
|
|
|
## Verify Docker Update (M3/M4)
|
|
|
|
Check logs:
|
|
|
|
```bash
|
|
docker logs akkudoktoreos
|
|
```
|
|
|
|
Then visit:
|
|
|
|
- API: [http://localhost:8503/docs](http://localhost:8503/docs)
|
|
- UI: [http://localhost:8504](http://localhost:8504)
|
|
|
|
## Updating Home Assistant Add-on Installation (M5)
|
|
|
|
1. Open 'Home Assistant' and navigate to 'Settings → Add-ons'.
|
|
2. Select the 'Akkudoktor-EOS' add-on from your installed add-ons.
|
|
3. If an update is available, click 'Update'.
|
|
4. Wait for the update process to finish, then restart the add-on if prompted.
|
|
|
|
If you installed Akkudoktor-EOS from a custom repository and no update appears, open the Add-on
|
|
Store, click the '⋮' menu in the top right, and choose 'Reload' to refresh the repository.
|
|
|
|
## Backup Recommendation
|
|
|
|
Before updating, back up your config:
|
|
|
|
```bash
|
|
EOS.config.json
|
|
```
|
|
|
|
EOS also maintains internal configuration backups.
|