Files
EOS/docs/_generated/configgeneral.md
Bobby Noelte 997e7646e9
Some checks failed
Bump Version / Bump Version Workflow (push) Has been cancelled
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: prevent exception when load prediction data is missing (#925)
Validate solution prediction data before processing.
If required prediction data is missing, the prediction is skipped
instead of raising an exception.

Introduce a new configuration file saving policy to improve loading robustness:
- Exclude computed fields
- Exclude fields set to their default values
- Exclude fields with value None
- Use field aliases
- Recursively remove empty dictionaries and lists
- Ensure general.version is always present and correctly set

When loading older configuration files, computed fields are now stripped
before migration. This further improves backward compatibility and loading
robustness.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2026-03-07 14:46:30 +01:00

2.6 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 Optional[str] rw None Configuration file version.
:::

Example Input

   {
       "general": {
           "version": "0.0.0",
           "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.0.0",
           "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"
       }
   }