EOS/docs/akkudoktoreos/architecture.md
Bobby Noelte bd38b3c5ef
Some checks failed
docker-build / platform-excludes (push) Has been cancelled
pre-commit / pre-commit (push) Has been cancelled
Run Pytest on Pull Request / test (push) Has been cancelled
docker-build / build (push) Has been cancelled
docker-build / merge (push) Has been cancelled
Close stale pull requests/issues / Find Stale issues and PRs (push) Has been cancelled
fix: logging, prediction update, multiple bugs (#584)
* Fix logging configuration issues that made logging stop operation. Switch to Loguru
  logging (from Python logging). Enable console and file logging with different log levels.
  Add logging documentation.

* Fix logging configuration and EOS configuration out of sync. Added tracking support
  for nested value updates of Pydantic models. This used to update the logging configuration
  when the EOS configurationm for logging is changed. Should keep logging config and EOS
  config in sync as long as all changes to the EOS logging configuration are done by
  set_nested_value(), which is the case for the REST API.

* Fix energy management task looping endlessly after the second update when trying to update
  the last_update datetime.

* Fix get_nested_value() to correctly take values from the dicts in a Pydantic model instance.

* Fix usage of model classes instead of model instances in nested value access when evaluation
  the value type that is associated to each key.

* Fix illegal json format in prediction documentation for PVForecastAkkudoktor provider.

* Fix documentation qirks and add EOS Connect to integrations.

* Support deprecated fields in configuration in documentation generation and EOSdash.

* Enhance EOSdash demo to show BrightSky humidity data (that is often missing)

* Update documentation reference to German EOS installation videos.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-06-10 22:00:28 +02:00

1.5 KiB

% SPDX-License-Identifier: Apache-2.0

Architecture

:alt: Overall System Architecture

Overall System Architecture

Overview of the Project Structure

Key Components and Their Roles

:alt: EOS Architecture

EOS Architecture

Configuration

The configuration controls all aspects of EOS: optimization, prediction, measurement, and energy management.

Energy Management

Energy management is the overall process to provide planning data for scheduling the different devices in your system in an optimal way. Energy management cares for the update of predictions and the optimization of the planning based on the simulated behavior of the devices. The planning is on the hour.

Optimization

Device Simulations

Device simulations simulate devices' behavior based on internal logic and predicted data. They provide the data needed for optimization.

Predictions

Predictions provide predicted future data to be used by the optimization.

Measurements

Measurements are utilized to refine predictions using real data from your system, thereby enhancing accuracy.

EOS Server

EOS operates as a REST API server.

EOSdash

EOSdash is a lightweight support dashboard for EOS. It is pre-integrated with EOS. When enabled, it can be accessed by navigating to http://localhost:8503 in your browser.