Files
EOS/docs/_generated/configgeneral.md
Christopher Nadler 04420e66ab
Some checks are pending
Bump Version / Bump Version Workflow (push) Waiting to run
docker-build / platform-excludes (push) Waiting to run
docker-build / build (push) Blocked by required conditions
docker-build / merge (push) Blocked by required conditions
pre-commit / pre-commit (push) Waiting to run
Run Pytest on Pull Request / test (push) Waiting to run
fix: Improve provider update error handling and add VRM provider settings validation (#887)
* fix: improve error handling for provider updates

Distinguishes failures of active providers from inactive ones.
Propagates errors only for enabled providers, allowing execution
to continue if a non-active provider fails, which avoids unnecessary
interruptions and improves robustness.

* fix: add provider settings validation for forecast requests

Prevents potential runtime errors by checking if provider settings are configured
before accessing forecast credentials.

Raises a clear error when settings are missing to help with debugging misconfigurations.

* refactor(load): move provider settings to top-level fields

Transitions load provider settings from a nested "provider_settings" object with provider-specific keys to dedicated top-level fields.\n\nRemoves the legacy "provider_settings" mapping and updates migration logic to ensure backward compatibility with existing configurations.

* docs: update version numbers and documantation

---------

Co-authored-by: Normann <github@koldrack.com>
2026-02-26 18:31:47 +01:00

2.7 KiB

General settings

:::{table} general :widths: 10 20 10 5 5 30 :align: left

Name Environment Variable Type Read-Only Default Description
config_file_path Optional[pathlib.Path] ro N/A Path to EOS configuration file.
config_folder_path Optional[pathlib.Path] ro N/A Path to EOS configuration directory.
data_folder_path EOS_GENERAL__DATA_FOLDER_PATH Path rw required Path to EOS data folder.
data_output_path Optional[pathlib.Path] ro N/A Computed data_output_path based on data_folder_path.
data_output_subpath EOS_GENERAL__DATA_OUTPUT_SUBPATH Optional[pathlib.Path] rw output Sub-path for the EOS output data folder.
home_assistant_addon EOS_GENERAL__HOME_ASSISTANT_ADDON bool rw required EOS is running as home assistant add-on.
latitude EOS_GENERAL__LATITUDE Optional[float] rw 52.52 Latitude in decimal degrees between -90 and 90. North is positive (ISO 19115) (°)
longitude EOS_GENERAL__LONGITUDE Optional[float] rw 13.405 Longitude in decimal degrees within -180 to 180 (°)
timezone Optional[str] ro N/A Computed timezone based on latitude and longitude.
version EOS_GENERAL__VERSION str rw 0.2.0.dev2602250574650225 Configuration file version. Used to check compatibility.
:::

Example Input

   {
       "general": {
           "version": "0.2.0.dev2602250574650225",
           "data_folder_path": "/home/user/.local/share/net.akkudoktoreos.net",
           "data_output_subpath": "output",
           "latitude": 52.52,
           "longitude": 13.405
       }
   }

Example Output

   {
       "general": {
           "version": "0.2.0.dev2602250574650225",
           "data_folder_path": "/home/user/.local/share/net.akkudoktoreos.net",
           "data_output_subpath": "output",
           "latitude": 52.52,
           "longitude": 13.405,
           "timezone": "Europe/Berlin",
           "data_output_path": "/home/user/.local/share/net.akkudoktoreos.net/output",
           "config_folder_path": "/home/user/.config/net.akkudoktoreos.net",
           "config_file_path": "/home/user/.config/net.akkudoktoreos.net/EOS.config.json"
       }
   }