mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2026-02-26 19:06:20 +00:00
32e690becf
Some checks failed
Bump Version / Bump Version Workflow (push) Has been cancelled
docker-build / platform-excludes (push) Has been cancelled
docker-build / build (push) Has been cancelled
docker-build / merge (push) Has been cancelled
pre-commit / pre-commit (push) Has been cancelled
Run Pytest on Pull Request / test (push) Has been cancelled
Startup retention manager for asynchronous tasks. Handle gracefully exceptions in these tasks or the configuration for them. Remove tasks.py as repeated tasks are now handled by the retention manager. When running on GitHub, only the version date file is checked. The development tag is merely a label, so any date set during development suffices. The test_doc is also skipped on GitHub actions.
2.7 KiB
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.dev2602242106748274 |
Configuration file version. Used to check compatibility. |
| ::: |
Example Input
{
"general": {
"version": "0.2.0.dev2602242106748274",
"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.dev2602242106748274",
"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"
}
}