Mirrors/EOS
1
0
Fork 0
mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2026-07-24 02:38:11 +00:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity
Files
3bb0e02aed7bb6ab96224aa377fa054abf0bfd0a
EOS/docs/_generated/configweather.md
Bobby Noelte 3bb0e02aed fix: provider settings in top level field of configuration (#1161) 
Configuration for some providers was given in the sub-field `provider_settings`
combining the settings of several providers. Pydantic does not understand
this very well and the configuration became cumbersome, especially in EOSdash.

All provider settings from the `provider-settings` sub-field are now lifted
to the top level field of the configuration.

The changes are automatically migrated in the configuration.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2026-07-20 14:37:03 +02:00

2.5 KiB
Raw Blame History

Weather Forecast Configuration

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

Name Environment Variable Type Read-Only Default Description
provider EOS_WEATHER__PROVIDER Optional[str] rw None Weather provider id of provider to be used.
providers list[str] ro N/A Available weather provider ids.
weatherimport EOS_WEATHER__WEATHERIMPORT WeatherImportCommonSettings rw required Weather import provider settings
:::

Example Input

   {
       "weather": {
           "provider": "WeatherImport",
           "weatherimport": {
               "import_file_path": null,
               "import_json": null
           }
       }
   }

Example Output

   {
       "weather": {
           "provider": "WeatherImport",
           "weatherimport": {
               "import_file_path": null,
               "import_json": null
           },
           "providers": [
               "BrightSky",
               "ClearOutside",
               "OpenMeteo",
               "WeatherImport"
           ]
       }
   }

Common settings for weather data import from file or JSON string

:::{table} weather::weatherimport :widths: 10 10 5 5 30 :align: left

Name Type Read-Only Default Description
import_file_path Union[str, pathlib.Path, NoneType] rw None Path to the file to import weather data from.
import_json Optional[str] rw None JSON string, dictionary of weather forecast value lists.
:::

Example Input/Output

   {
       "weather": {
           "weatherimport": {
               "import_file_path": null,
               "import_json": "{\"weather_temp_air\": [18.3, 17.8, 16.9]}"
           }
       }
   }