Load Prediction Configuration

load

Name	Environment Variable	Type	Read-Only	Default	Description
provider	EOS_LOAD__PROVIDER	Optional[str]	rw	None	Load provider id of provider to be used.
provider_settings	EOS_LOAD__PROVIDER_SETTINGS	LoadCommonProviderSettings	rw	required	Provider settings
providers		list[str]	ro	N/A	Available load provider ids.

Example Input

   {
       "load": {
           "provider": "LoadAkkudoktor",
           "provider_settings": {
               "LoadAkkudoktor": null,
               "LoadVrm": null,
               "LoadImport": null
           }
       }
   }

Example Output

   {
       "load": {
           "provider": "LoadAkkudoktor",
           "provider_settings": {
               "LoadAkkudoktor": null,
               "LoadVrm": null,
               "LoadImport": null
           },
           "providers": [
               "LoadAkkudoktor",
               "LoadAkkudoktorAdjusted",
               "LoadVrm",
               "LoadImport"
           ]
       }
   }

Common settings for load data import from file or JSON string

load::provider_settings::LoadImport

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

Example Input/Output

   {
       "load": {
           "provider_settings": {
               "LoadImport": {
                   "import_file_path": null,
                   "import_json": "{\"load0_mean\": [676.71, 876.19, 527.13]}"
               }
           }
       }
   }

Common settings for load forecast VRM API

load::provider_settings::LoadVrm

Name	Type	Read-Only	Default	Description
load_vrm_idsite	int	rw	12345	VRM-Installation-ID
load_vrm_token	str	rw	your-token	Token for Connecting VRM API

Example Input/Output

   {
       "load": {
           "provider_settings": {
               "LoadVrm": {
                   "load_vrm_token": "your-token",
                   "load_vrm_idsite": 12345
               }
           }
       }
   }

Common settings for load data import from file

load::provider_settings::LoadAkkudoktor

Name	Type	Read-Only	Default	Description
loadakkudoktor_year_energy_kwh	Optional[float]	rw	None	Yearly energy consumption (kWh).

Example Input/Output

   {
       "load": {
           "provider_settings": {
               "LoadAkkudoktor": {
                   "loadakkudoktor_year_energy_kwh": 40421.0
               }
           }
       }
   }

Load Prediction Provider Configuration

load::provider_settings

Name	Type	Read-Only	Default	Description
LoadAkkudoktor	Optional[akkudoktoreos.prediction.loadakkudoktor.LoadAkkudoktorCommonSettings]	rw	None	LoadAkkudoktor settings
LoadImport	Optional[akkudoktoreos.prediction.loadimport.LoadImportCommonSettings]	rw	None	LoadImport settings
LoadVrm	Optional[akkudoktoreos.prediction.loadvrm.LoadVrmCommonSettings]	rw	None	LoadVrm settings

Example Input/Output

   {
       "load": {
           "provider_settings": {
               "LoadAkkudoktor": null,
               "LoadVrm": null,
               "LoadImport": null
           }
       }
   }