Mirrors/EOS
1
0
Fork 0
mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2025-03-18 18:44:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
main
EOS/openapi.json
Bobby Noelte 43ebbc2e55
Fix gesamtlast_simple (#399) 
Legacy endpoint gesamtlast_simple expected yearly energy consumption to be given in Wh SI units.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-01-21 16:56:42 +01:00

8983 lines
275 KiB
JSON
Raw Permalink Blame History

{
"openapi": "3.1.0",
"info": {
"title": "Akkudoktor-EOS",
"description": "This project provides a comprehensive solution for simulating and optimizing an energy system based on renewable energy sources. With a focus on photovoltaic (PV) systems, battery storage (batteries), load management (consumer requirements), heat pumps, electric vehicles, and consideration of electricity price data, this system enables forecasting and optimization of energy flow and costs over a specified period.",
"version": "0.0.1"
},
"paths": {
"/v1/config/value": {
"put": {
"summary": "Fastapi Config Value Put",
"description": "Set the configuration option in the settings.\n\nArgs:\n key (str): configuration key\n value (Any): configuration value\n\nReturns:\n configuration (ConfigEOS): The current configuration after the write.",
"operationId": "fastapi_config_value_put_v1_config_value_put",
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "configuration key",
"title": "Key"
},
"description": "configuration key"
},
{
"name": "value",
"in": "query",
"required": true,
"schema": {
"description": "configuration value",
"title": "Value"
},
"description": "configuration value"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigEOS"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v1/config/update": {
"post": {
"summary": "Fastapi Config Update Post",
"description": "Update the configuration from the EOS configuration file.\n\nReturns:\n configuration (ConfigEOS): The current configuration after update.",
"operationId": "fastapi_config_update_post_v1_config_update_post",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigEOS"
}
}
}
}
}
}
},
"/v1/config/file": {
"get": {
"summary": "Fastapi Config File Get",
"description": "Get the settings as defined by the EOS configuration file.\n\nReturns:\n settings (SettingsEOS): The settings defined by the EOS configuration file.",
"operationId": "fastapi_config_file_get_v1_config_file_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SettingsEOS"
}
}
}
}
}
},
"put": {
"summary": "Fastapi Config File Put",
"description": "Save the current configuration to the EOS configuration file.\n\nReturns:\n configuration (ConfigEOS): The current configuration that was saved.",
"operationId": "fastapi_config_file_put_v1_config_file_put",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigEOS"
}
}
}
}
}
}
},
"/v1/config": {
"get": {
"summary": "Fastapi Config Get",
"description": "Get the current configuration.\n\nReturns:\n configuration (ConfigEOS): The current configuration.",
"operationId": "fastapi_config_get_v1_config_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigEOS"
}
}
}
}
}
},
"put": {
"summary": "Fastapi Config Put",
"description": "Write the provided settings into the current settings.\n\nThe existing settings are completely overwritten. Note that for any setting\nvalue that is None, the configuration will fall back to values from other sources such as\nenvironment variables, the EOS configuration file, or default values.\n\nArgs:\n settings (SettingsEOS): The settings to write into the current settings.\n\nReturns:\n configuration (ConfigEOS): The current configuration after the write.",
"operationId": "fastapi_config_put_v1_config_put",
"parameters": [
{
"name": "server_eos_host",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "ipvanyaddress"
},
{
"type": "null"
}
],
"description": "EOS server IP address.",
"default": "0.0.0.0",
"title": "Server Eos Host"
},
"description": "EOS server IP address."
},
{
"name": "server_eos_port",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "EOS server IP port number.",
"default": 8503,
"title": "Server Eos Port"
},
"description": "EOS server IP port number."
},
{
"name": "server_eos_verbose",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Enable debug output",
"default": false,
"title": "Server Eos Verbose"
},
"description": "Enable debug output"
},
{
"name": "server_eos_startup_eosdash",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "EOS server to start EOSdash server.",
"default": true,
"title": "Server Eos Startup Eosdash"
},
"description": "EOS server to start EOSdash server."
},
{
"name": "server_eosdash_host",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "ipvanyaddress"
},
{
"type": "null"
}
],
"description": "EOSdash server IP address.",
"default": "0.0.0.0",
"title": "Server Eosdash Host"
},
"description": "EOSdash server IP address."
},
{
"name": "server_eosdash_port",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "EOSdash server IP port number.",
"default": 8504,
"title": "Server Eosdash Port"
},
"description": "EOSdash server IP port number."
},
{
"name": "weatherimport_file_path",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"description": "Path to the file to import weather data from.",
"title": "Weatherimport File Path"
},
"description": "Path to the file to import weather data from."
},
{
"name": "weatherimport_json",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON string, dictionary of weather forecast value lists.",
"title": "Weatherimport Json"
},
"description": "JSON string, dictionary of weather forecast value lists."
},
{
"name": "weather_provider",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Weather provider id of provider to be used.",
"title": "Weather Provider"
},
"description": "Weather provider id of provider to be used."
},
{
"name": "pvforecastimport_file_path",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"description": "Path to the file to import PV forecast data from.",
"title": "Pvforecastimport File Path"
},
"description": "Path to the file to import PV forecast data from."
},
{
"name": "pvforecastimport_json",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON string, dictionary of PV forecast value lists.",
"title": "Pvforecastimport Json"
},
"description": "JSON string, dictionary of PV forecast value lists."
},
{
"name": "pvforecast_provider",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "PVForecast provider id of provider to be used.",
"title": "Pvforecast Provider"
},
"description": "PVForecast provider id of provider to be used."
},
{
"name": "pvforecast0_surface_tilt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking.",
"title": "Pvforecast0 Surface Tilt"
},
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking."
},
{
"name": "pvforecast0_surface_azimuth",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270).",
"title": "Pvforecast0 Surface Azimuth"
},
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)."
},
{
"name": "pvforecast0_userhorizon",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "number"
}
},
{
"type": "null"
}
],
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north.",
"title": "Pvforecast0 Userhorizon"
},
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north."
},
{
"name": "pvforecast0_peakpower",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Nominal power of PV system in kW.",
"title": "Pvforecast0 Peakpower"
},
"description": "Nominal power of PV system in kW."
},
{
"name": "pvforecast0_pvtechchoice",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'.",
"default": "crystSi",
"title": "Pvforecast0 Pvtechchoice"
},
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'."
},
{
"name": "pvforecast0_mountingplace",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated.",
"default": "free",
"title": "Pvforecast0 Mountingplace"
},
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated."
},
{
"name": "pvforecast0_loss",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Sum of PV system losses in percent",
"default": 14.0,
"title": "Pvforecast0 Loss"
},
"description": "Sum of PV system losses in percent"
},
{
"name": "pvforecast0_trackingtype",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south.",
"title": "Pvforecast0 Trackingtype"
},
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south."
},
{
"name": "pvforecast0_optimal_surface_tilt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking.",
"default": false,
"title": "Pvforecast0 Optimal Surface Tilt"
},
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking."
},
{
"name": "pvforecast0_optimalangles",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking.",
"default": false,
"title": "Pvforecast0 Optimalangles"
},
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking."
},
{
"name": "pvforecast0_albedo",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Proportion of the light hitting the ground that it reflects back.",
"title": "Pvforecast0 Albedo"
},
"description": "Proportion of the light hitting the ground that it reflects back."
},
{
"name": "pvforecast0_module_model",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Model of the PV modules of this plane.",
"title": "Pvforecast0 Module Model"
},
"description": "Model of the PV modules of this plane."
},
{
"name": "pvforecast0_inverter_model",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Model of the inverter of this plane.",
"title": "Pvforecast0 Inverter Model"
},
"description": "Model of the inverter of this plane."
},
{
"name": "pvforecast0_inverter_paco",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "AC power rating of the inverter. [W]",
"title": "Pvforecast0 Inverter Paco"
},
"description": "AC power rating of the inverter. [W]"
},
{
"name": "pvforecast0_modules_per_string",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Number of the PV modules of the strings of this plane.",
"title": "Pvforecast0 Modules Per String"
},
"description": "Number of the PV modules of the strings of this plane."
},
{
"name": "pvforecast0_strings_per_inverter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Number of the strings of the inverter of this plane.",
"title": "Pvforecast0 Strings Per Inverter"
},
"description": "Number of the strings of the inverter of this plane."
},
{
"name": "pvforecast1_surface_tilt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking.",
"title": "Pvforecast1 Surface Tilt"
},
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking."
},
{
"name": "pvforecast1_surface_azimuth",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270).",
"title": "Pvforecast1 Surface Azimuth"
},
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)."
},
{
"name": "pvforecast1_userhorizon",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "number"
}
},
{
"type": "null"
}
],
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north.",
"title": "Pvforecast1 Userhorizon"
},
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north."
},
{
"name": "pvforecast1_peakpower",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Nominal power of PV system in kW.",
"title": "Pvforecast1 Peakpower"
},
"description": "Nominal power of PV system in kW."
},
{
"name": "pvforecast1_pvtechchoice",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'.",
"default": "crystSi",
"title": "Pvforecast1 Pvtechchoice"
},
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'."
},
{
"name": "pvforecast1_mountingplace",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated.",
"default": "free",
"title": "Pvforecast1 Mountingplace"
},
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated."
},
{
"name": "pvforecast1_loss",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Sum of PV system losses in percent",
"default": 14.0,
"title": "Pvforecast1 Loss"
},
"description": "Sum of PV system losses in percent"
},
{
"name": "pvforecast1_trackingtype",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south.",
"title": "Pvforecast1 Trackingtype"
},
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south."
},
{
"name": "pvforecast1_optimal_surface_tilt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking.",
"default": false,
"title": "Pvforecast1 Optimal Surface Tilt"
},
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking."
},
{
"name": "pvforecast1_optimalangles",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking.",
"default": false,
"title": "Pvforecast1 Optimalangles"
},
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking."
},
{
"name": "pvforecast1_albedo",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Proportion of the light hitting the ground that it reflects back.",
"title": "Pvforecast1 Albedo"
},
"description": "Proportion of the light hitting the ground that it reflects back."
},
{
"name": "pvforecast1_module_model",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Model of the PV modules of this plane.",
"title": "Pvforecast1 Module Model"
},
"description": "Model of the PV modules of this plane."
},
{
"name": "pvforecast1_inverter_model",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Model of the inverter of this plane.",
"title": "Pvforecast1 Inverter Model"
},
"description": "Model of the inverter of this plane."
},
{
"name": "pvforecast1_inverter_paco",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "AC power rating of the inverter. [W]",
"title": "Pvforecast1 Inverter Paco"
},
"description": "AC power rating of the inverter. [W]"
},
{
"name": "pvforecast1_modules_per_string",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Number of the PV modules of the strings of this plane.",
"title": "Pvforecast1 Modules Per String"
},
"description": "Number of the PV modules of the strings of this plane."
},
{
"name": "pvforecast1_strings_per_inverter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Number of the strings of the inverter of this plane.",
"title": "Pvforecast1 Strings Per Inverter"
},
"description": "Number of the strings of the inverter of this plane."
},
{
"name": "pvforecast2_surface_tilt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking.",
"title": "Pvforecast2 Surface Tilt"
},
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking."
},
{
"name": "pvforecast2_surface_azimuth",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270).",
"title": "Pvforecast2 Surface Azimuth"
},
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)."
},
{
"name": "pvforecast2_userhorizon",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "number"
}
},
{
"type": "null"
}
],
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north.",
"title": "Pvforecast2 Userhorizon"
},
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north."
},
{
"name": "pvforecast2_peakpower",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Nominal power of PV system in kW.",
"title": "Pvforecast2 Peakpower"
},
"description": "Nominal power of PV system in kW."
},
{
"name": "pvforecast2_pvtechchoice",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'.",
"default": "crystSi",
"title": "Pvforecast2 Pvtechchoice"
},
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'."
},
{
"name": "pvforecast2_mountingplace",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated.",
"default": "free",
"title": "Pvforecast2 Mountingplace"
},
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated."
},
{
"name": "pvforecast2_loss",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Sum of PV system losses in percent",
"default": 14.0,
"title": "Pvforecast2 Loss"
},
"description": "Sum of PV system losses in percent"
},
{
"name": "pvforecast2_trackingtype",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south.",
"title": "Pvforecast2 Trackingtype"
},
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south."
},
{
"name": "pvforecast2_optimal_surface_tilt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking.",
"default": false,
"title": "Pvforecast2 Optimal Surface Tilt"
},
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking."
},
{
"name": "pvforecast2_optimalangles",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking.",
"default": false,
"title": "Pvforecast2 Optimalangles"
},
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking."
},
{
"name": "pvforecast2_albedo",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Proportion of the light hitting the ground that it reflects back.",
"title": "Pvforecast2 Albedo"
},
"description": "Proportion of the light hitting the ground that it reflects back."
},
{
"name": "pvforecast2_module_model",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Model of the PV modules of this plane.",
"title": "Pvforecast2 Module Model"
},
"description": "Model of the PV modules of this plane."
},
{
"name": "pvforecast2_inverter_model",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Model of the inverter of this plane.",
"title": "Pvforecast2 Inverter Model"
},
"description": "Model of the inverter of this plane."
},
{
"name": "pvforecast2_inverter_paco",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "AC power rating of the inverter. [W]",
"title": "Pvforecast2 Inverter Paco"
},
"description": "AC power rating of the inverter. [W]"
},
{
"name": "pvforecast2_modules_per_string",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Number of the PV modules of the strings of this plane.",
"title": "Pvforecast2 Modules Per String"
},
"description": "Number of the PV modules of the strings of this plane."
},
{
"name": "pvforecast2_strings_per_inverter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Number of the strings of the inverter of this plane.",
"title": "Pvforecast2 Strings Per Inverter"
},
"description": "Number of the strings of the inverter of this plane."
},
{
"name": "pvforecast3_surface_tilt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking.",
"title": "Pvforecast3 Surface Tilt"
},
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking."
},
{
"name": "pvforecast3_surface_azimuth",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270).",
"title": "Pvforecast3 Surface Azimuth"
},
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)."
},
{
"name": "pvforecast3_userhorizon",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "number"
}
},
{
"type": "null"
}
],
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north.",
"title": "Pvforecast3 Userhorizon"
},
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north."
},
{
"name": "pvforecast3_peakpower",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Nominal power of PV system in kW.",
"title": "Pvforecast3 Peakpower"
},
"description": "Nominal power of PV system in kW."
},
{
"name": "pvforecast3_pvtechchoice",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'.",
"default": "crystSi",
"title": "Pvforecast3 Pvtechchoice"
},
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'."
},
{
"name": "pvforecast3_mountingplace",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated.",
"default": "free",
"title": "Pvforecast3 Mountingplace"
},
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated."
},
{
"name": "pvforecast3_loss",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Sum of PV system losses in percent",
"default": 14.0,
"title": "Pvforecast3 Loss"
},
"description": "Sum of PV system losses in percent"
},
{
"name": "pvforecast3_trackingtype",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south.",
"title": "Pvforecast3 Trackingtype"
},
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south."
},
{
"name": "pvforecast3_optimal_surface_tilt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking.",
"default": false,
"title": "Pvforecast3 Optimal Surface Tilt"
},
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking."
},
{
"name": "pvforecast3_optimalangles",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking.",
"default": false,
"title": "Pvforecast3 Optimalangles"
},
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking."
},
{
"name": "pvforecast3_albedo",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Proportion of the light hitting the ground that it reflects back.",
"title": "Pvforecast3 Albedo"
},
"description": "Proportion of the light hitting the ground that it reflects back."
},
{
"name": "pvforecast3_module_model",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Model of the PV modules of this plane.",
"title": "Pvforecast3 Module Model"
},
"description": "Model of the PV modules of this plane."
},
{
"name": "pvforecast3_inverter_model",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Model of the inverter of this plane.",
"title": "Pvforecast3 Inverter Model"
},
"description": "Model of the inverter of this plane."
},
{
"name": "pvforecast3_inverter_paco",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "AC power rating of the inverter. [W]",
"title": "Pvforecast3 Inverter Paco"
},
"description": "AC power rating of the inverter. [W]"
},
{
"name": "pvforecast3_modules_per_string",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Number of the PV modules of the strings of this plane.",
"title": "Pvforecast3 Modules Per String"
},
"description": "Number of the PV modules of the strings of this plane."
},
{
"name": "pvforecast3_strings_per_inverter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Number of the strings of the inverter of this plane.",
"title": "Pvforecast3 Strings Per Inverter"
},
"description": "Number of the strings of the inverter of this plane."
},
{
"name": "pvforecast4_surface_tilt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking.",
"title": "Pvforecast4 Surface Tilt"
},
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking."
},
{
"name": "pvforecast4_surface_azimuth",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270).",
"title": "Pvforecast4 Surface Azimuth"
},
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)."
},
{
"name": "pvforecast4_userhorizon",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "number"
}
},
{
"type": "null"
}
],
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north.",
"title": "Pvforecast4 Userhorizon"
},
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north."
},
{
"name": "pvforecast4_peakpower",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Nominal power of PV system in kW.",
"title": "Pvforecast4 Peakpower"
},
"description": "Nominal power of PV system in kW."
},
{
"name": "pvforecast4_pvtechchoice",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'.",
"default": "crystSi",
"title": "Pvforecast4 Pvtechchoice"
},
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'."
},
{
"name": "pvforecast4_mountingplace",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated.",
"default": "free",
"title": "Pvforecast4 Mountingplace"
},
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated."
},
{
"name": "pvforecast4_loss",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Sum of PV system losses in percent",
"default": 14.0,
"title": "Pvforecast4 Loss"
},
"description": "Sum of PV system losses in percent"
},
{
"name": "pvforecast4_trackingtype",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south.",
"title": "Pvforecast4 Trackingtype"
},
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south."
},
{
"name": "pvforecast4_optimal_surface_tilt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking.",
"default": false,
"title": "Pvforecast4 Optimal Surface Tilt"
},
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking."
},
{
"name": "pvforecast4_optimalangles",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking.",
"default": false,
"title": "Pvforecast4 Optimalangles"
},
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking."
},
{
"name": "pvforecast4_albedo",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Proportion of the light hitting the ground that it reflects back.",
"title": "Pvforecast4 Albedo"
},
"description": "Proportion of the light hitting the ground that it reflects back."
},
{
"name": "pvforecast4_module_model",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Model of the PV modules of this plane.",
"title": "Pvforecast4 Module Model"
},
"description": "Model of the PV modules of this plane."
},
{
"name": "pvforecast4_inverter_model",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Model of the inverter of this plane.",
"title": "Pvforecast4 Inverter Model"
},
"description": "Model of the inverter of this plane."
},
{
"name": "pvforecast4_inverter_paco",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "AC power rating of the inverter. [W]",
"title": "Pvforecast4 Inverter Paco"
},
"description": "AC power rating of the inverter. [W]"
},
{
"name": "pvforecast4_modules_per_string",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Number of the PV modules of the strings of this plane.",
"title": "Pvforecast4 Modules Per String"
},
"description": "Number of the PV modules of the strings of this plane."
},
{
"name": "pvforecast4_strings_per_inverter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Number of the strings of the inverter of this plane.",
"title": "Pvforecast4 Strings Per Inverter"
},
"description": "Number of the strings of the inverter of this plane."
},
{
"name": "pvforecast5_surface_tilt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking.",
"title": "Pvforecast5 Surface Tilt"
},
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking."
},
{
"name": "pvforecast5_surface_azimuth",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270).",
"title": "Pvforecast5 Surface Azimuth"
},
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)."
},
{
"name": "pvforecast5_userhorizon",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "number"
}
},
{
"type": "null"
}
],
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north.",
"title": "Pvforecast5 Userhorizon"
},
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north."
},
{
"name": "pvforecast5_peakpower",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Nominal power of PV system in kW.",
"title": "Pvforecast5 Peakpower"
},
"description": "Nominal power of PV system in kW."
},
{
"name": "pvforecast5_pvtechchoice",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'.",
"default": "crystSi",
"title": "Pvforecast5 Pvtechchoice"
},
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'."
},
{
"name": "pvforecast5_mountingplace",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated.",
"default": "free",
"title": "Pvforecast5 Mountingplace"
},
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated."
},
{
"name": "pvforecast5_loss",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Sum of PV system losses in percent",
"default": 14.0,
"title": "Pvforecast5 Loss"
},
"description": "Sum of PV system losses in percent"
},
{
"name": "pvforecast5_trackingtype",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south.",
"title": "Pvforecast5 Trackingtype"
},
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south."
},
{
"name": "pvforecast5_optimal_surface_tilt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking.",
"default": false,
"title": "Pvforecast5 Optimal Surface Tilt"
},
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking."
},
{
"name": "pvforecast5_optimalangles",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking.",
"default": false,
"title": "Pvforecast5 Optimalangles"
},
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking."
},
{
"name": "pvforecast5_albedo",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Proportion of the light hitting the ground that it reflects back.",
"title": "Pvforecast5 Albedo"
},
"description": "Proportion of the light hitting the ground that it reflects back."
},
{
"name": "pvforecast5_module_model",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Model of the PV modules of this plane.",
"title": "Pvforecast5 Module Model"
},
"description": "Model of the PV modules of this plane."
},
{
"name": "pvforecast5_inverter_model",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Model of the inverter of this plane.",
"title": "Pvforecast5 Inverter Model"
},
"description": "Model of the inverter of this plane."
},
{
"name": "pvforecast5_inverter_paco",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "AC power rating of the inverter. [W]",
"title": "Pvforecast5 Inverter Paco"
},
"description": "AC power rating of the inverter. [W]"
},
{
"name": "pvforecast5_modules_per_string",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Number of the PV modules of the strings of this plane.",
"title": "Pvforecast5 Modules Per String"
},
"description": "Number of the PV modules of the strings of this plane."
},
{
"name": "pvforecast5_strings_per_inverter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Number of the strings of the inverter of this plane.",
"title": "Pvforecast5 Strings Per Inverter"
},
"description": "Number of the strings of the inverter of this plane."
},
{
"name": "load_import_file_path",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"description": "Path to the file to import load data from.",
"title": "Load Import File Path"
},
"description": "Path to the file to import load data from."
},
{
"name": "load_import_json",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON string, dictionary of load forecast value lists.",
"title": "Load Import Json"
},
"description": "JSON string, dictionary of load forecast value lists."
},
{
"name": "loadakkudoktor_year_energy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Yearly energy consumption (kWh).",
"title": "Loadakkudoktor Year Energy"
},
"description": "Yearly energy consumption (kWh)."
},
{
"name": "load_provider",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Load provider id of provider to be used.",
"title": "Load Provider"
},
"description": "Load provider id of provider to be used."
},
{
"name": "elecpriceimport_file_path",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"description": "Path to the file to import elecprice data from.",
"title": "Elecpriceimport File Path"
},
"description": "Path to the file to import elecprice data from."
},
{
"name": "elecpriceimport_json",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "JSON string, dictionary of electricity price forecast value lists.",
"title": "Elecpriceimport Json"
},
"description": "JSON string, dictionary of electricity price forecast value lists."
},
{
"name": "elecprice_provider",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Electricity price provider id of provider to be used.",
"title": "Elecprice Provider"
},
"description": "Electricity price provider id of provider to be used."
},
{
"name": "elecprice_charges_kwh",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number",
"minimum": 0.0
},
{
"type": "null"
}
],
"description": "Electricity price charges (\u20ac/kWh).",
"title": "Elecprice Charges Kwh"
},
"description": "Electricity price charges (\u20ac/kWh)."
},
{
"name": "prediction_hours",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
}
],
"description": "Number of hours into the future for predictions",
"default": 48,
"title": "Prediction Hours"
},
"description": "Number of hours into the future for predictions"
},
{
"name": "prediction_historic_hours",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
}
],
"description": "Number of hours into the past for historical predictions data",
"default": 48,
"title": "Prediction Historic Hours"
},
"description": "Number of hours into the past for historical predictions data"
},
{
"name": "latitude",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number",
"maximum": 90.0,
"minimum": -90.0
},
{
"type": "null"
}
],
"description": "Latitude in decimal degrees, between -90 and 90, north is positive (ISO 19115) (\u00b0)",
"title": "Latitude"
},
"description": "Latitude in decimal degrees, between -90 and 90, north is positive (ISO 19115) (\u00b0)"
},
{
"name": "longitude",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number",
"maximum": 180.0,
"minimum": -180.0
},
{
"type": "null"
}
],
"description": "Longitude in decimal degrees, within -180 to 180 (\u00b0)",
"title": "Longitude"
},
"description": "Longitude in decimal degrees, within -180 to 180 (\u00b0)"
},
{
"name": "optimization_hours",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
}
],
"description": "Number of hours into the future for optimizations.",
"default": 24,
"title": "Optimization Hours"
},
"description": "Number of hours into the future for optimizations."
},
{
"name": "optimization_penalty",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Penalty factor used in optimization.",
"default": 10,
"title": "Optimization Penalty"
},
"description": "Penalty factor used in optimization."
},
{
"name": "optimization_ev_available_charge_rates_percent",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "number"
}
},
{
"type": "null"
}
],
"description": "Charge rates available for the EV in percent of maximum charge.",
"default": [
0.0,
0.375,
0.5,
0.625,
0.75,
0.875,
1.0
],
"title": "Optimization Ev Available Charge Rates Percent"
},
"description": "Charge rates available for the EV in percent of maximum charge."
},
{
"name": "measurement_load0_name",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the load0 source (e.g. 'Household', 'Heat Pump')",
"title": "Measurement Load0 Name"
},
"description": "Name of the load0 source (e.g. 'Household', 'Heat Pump')"
},
{
"name": "measurement_load1_name",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the load1 source (e.g. 'Household', 'Heat Pump')",
"title": "Measurement Load1 Name"
},
"description": "Name of the load1 source (e.g. 'Household', 'Heat Pump')"
},
{
"name": "measurement_load2_name",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the load2 source (e.g. 'Household', 'Heat Pump')",
"title": "Measurement Load2 Name"
},
"description": "Name of the load2 source (e.g. 'Household', 'Heat Pump')"
},
{
"name": "measurement_load3_name",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the load3 source (e.g. 'Household', 'Heat Pump')",
"title": "Measurement Load3 Name"
},
"description": "Name of the load3 source (e.g. 'Household', 'Heat Pump')"
},
{
"name": "measurement_load4_name",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the load4 source (e.g. 'Household', 'Heat Pump')",
"title": "Measurement Load4 Name"
},
"description": "Name of the load4 source (e.g. 'Household', 'Heat Pump')"
},
{
"name": "battery_provider",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Id of Battery simulation provider.",
"title": "Battery Provider"
},
"description": "Id of Battery simulation provider."
},
{
"name": "battery_capacity",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Battery capacity [Wh].",
"title": "Battery Capacity"
},
"description": "Battery capacity [Wh]."
},
{
"name": "battery_initial_soc",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Battery initial state of charge [%].",
"title": "Battery Initial Soc"
},
"description": "Battery initial state of charge [%]."
},
{
"name": "battery_soc_min",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Battery minimum state of charge [%].",
"title": "Battery Soc Min"
},
"description": "Battery minimum state of charge [%]."
},
{
"name": "battery_soc_max",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Battery maximum state of charge [%].",
"title": "Battery Soc Max"
},
"description": "Battery maximum state of charge [%]."
},
{
"name": "battery_charging_efficiency",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Battery charging efficiency [%].",
"title": "Battery Charging Efficiency"
},
"description": "Battery charging efficiency [%]."
},
{
"name": "battery_discharging_efficiency",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Battery discharging efficiency [%].",
"title": "Battery Discharging Efficiency"
},
"description": "Battery discharging efficiency [%]."
},
{
"name": "battery_max_charging_power",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Battery maximum charge power [W].",
"title": "Battery Max Charging Power"
},
"description": "Battery maximum charge power [W]."
},
{
"name": "bev_provider",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Id of Battery Electric Vehicle simulation provider.",
"title": "Bev Provider"
},
"description": "Id of Battery Electric Vehicle simulation provider."
},
{
"name": "bev_capacity",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Battery Electric Vehicle capacity [Wh].",
"title": "Bev Capacity"
},
"description": "Battery Electric Vehicle capacity [Wh]."
},
{
"name": "bev_initial_soc",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Battery Electric Vehicle initial state of charge [%].",
"title": "Bev Initial Soc"
},
"description": "Battery Electric Vehicle initial state of charge [%]."
},
{
"name": "bev_soc_max",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Battery Electric Vehicle maximum state of charge [%].",
"title": "Bev Soc Max"
},
"description": "Battery Electric Vehicle maximum state of charge [%]."
},
{
"name": "bev_charging_efficiency",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Battery Electric Vehicle charging efficiency [%].",
"title": "Bev Charging Efficiency"
},
"description": "Battery Electric Vehicle charging efficiency [%]."
},
{
"name": "bev_discharging_efficiency",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Battery Electric Vehicle discharging efficiency [%].",
"title": "Bev Discharging Efficiency"
},
"description": "Battery Electric Vehicle discharging efficiency [%]."
},
{
"name": "bev_max_charging_power",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Battery Electric Vehicle maximum charge power [W].",
"title": "Bev Max Charging Power"
},
"description": "Battery Electric Vehicle maximum charge power [W]."
},
{
"name": "dishwasher_provider",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Id of Dish Washer simulation provider.",
"title": "Dishwasher Provider"
},
"description": "Id of Dish Washer simulation provider."
},
{
"name": "dishwasher_consumption",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Dish Washer energy consumption [Wh].",
"title": "Dishwasher Consumption"
},
"description": "Dish Washer energy consumption [Wh]."
},
{
"name": "dishwasher_duration",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Dish Washer usage duration [h].",
"title": "Dishwasher Duration"
},
"description": "Dish Washer usage duration [h]."
},
{
"name": "inverter_provider",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Id of PV Inverter simulation provider.",
"title": "Inverter Provider"
},
"description": "Id of PV Inverter simulation provider."
},
{
"name": "inverter_power_max",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Inverter maximum power [W].",
"title": "Inverter Power Max"
},
"description": "Inverter maximum power [W]."
},
{
"name": "logging_level_default",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "EOS default logging level.",
"title": "Logging Level Default"
},
"description": "EOS default logging level."
},
{
"name": "data_folder_path",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"description": "Path to EOS data directory.",
"title": "Data Folder Path"
},
"description": "Path to EOS data directory."
},
{
"name": "data_output_subpath",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"description": "Sub-path for the EOS output data directory.",
"default": "output",
"title": "Data Output Subpath"
},
"description": "Sub-path for the EOS output data directory."
},
{
"name": "data_cache_subpath",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"description": "Sub-path for the EOS cache data directory.",
"default": "cache",
"title": "Data Cache Subpath"
},
"description": "Sub-path for the EOS cache data directory."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigEOS"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v1/measurement/keys": {
"get": {
"summary": "Fastapi Measurement Keys Get",
"description": "Get a list of available measurement keys.",
"operationId": "fastapi_measurement_keys_get_v1_measurement_keys_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Response Fastapi Measurement Keys Get V1 Measurement Keys Get"
}
}
}
}
}
}
},
"/v1/measurement/load-mr/series/by-name": {
"get": {
"summary": "Fastapi Measurement Load Mr Series By Name Get",
"description": "Get the meter reading of given load name as series.",
"operationId": "fastapi_measurement_load_mr_series_by_name_get_v1_measurement_load_mr_series_by_name_get",
"parameters": [
{
"name": "name",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "Load name.",
"title": "Name"
},
"description": "Load name."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PydanticDateTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"summary": "Fastapi Measurement Load Mr Series By Name Put",
"description": "Merge the meter readings series of given load name into EOS measurements at given datetime.",
"operationId": "fastapi_measurement_load_mr_series_by_name_put_v1_measurement_load_mr_series_by_name_put",
"parameters": [
{
"name": "name",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "Load name.",
"title": "Name"
},
"description": "Load name."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PydanticDateTimeSeries"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PydanticDateTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v1/measurement/load-mr/value/by-name": {
"put": {
"summary": "Fastapi Measurement Load Mr Value By Name Put",
"description": "Merge the meter reading of given load name and value into EOS measurements at given datetime.",
"operationId": "fastapi_measurement_load_mr_value_by_name_put_v1_measurement_load_mr_value_by_name_put",
"parameters": [
{
"name": "datetime",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "Datetime.",
"title": "Datetime"
},
"description": "Datetime."
},
{
"name": "name",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "Load name.",
"title": "Name"
},
"description": "Load name."
},
{
"name": "value",
"in": "query",
"required": true,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"title": "Value"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PydanticDateTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v1/measurement/series": {
"get": {
"summary": "Fastapi Measurement Series Get",
"description": "Get the measurements of given key as series.",
"operationId": "fastapi_measurement_series_get_v1_measurement_series_get",
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "Prediction key.",
"title": "Key"
},
"description": "Prediction key."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PydanticDateTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"summary": "Fastapi Measurement Series Put",
"description": "Merge measurement given as series into given key.",
"operationId": "fastapi_measurement_series_put_v1_measurement_series_put",
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "Prediction key.",
"title": "Key"
},
"description": "Prediction key."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PydanticDateTimeSeries"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PydanticDateTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v1/measurement/value": {
"put": {
"summary": "Fastapi Measurement Value Put",
"description": "Merge the measurement of given key and value into EOS measurements at given datetime.",
"operationId": "fastapi_measurement_value_put_v1_measurement_value_put",
"parameters": [
{
"name": "datetime",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "Datetime.",
"title": "Datetime"
},
"description": "Datetime."
},
{
"name": "key",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "Prediction key.",
"title": "Key"
},
"description": "Prediction key."
},
{
"name": "value",
"in": "query",
"required": true,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"title": "Value"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PydanticDateTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v1/measurement/dataframe": {
"put": {
"summary": "Fastapi Measurement Dataframe Put",
"description": "Merge the measurement data given as dataframe into EOS measurements.",
"operationId": "fastapi_measurement_dataframe_put_v1_measurement_dataframe_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PydanticDateTimeDataFrame"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v1/measurement/data": {
"put": {
"summary": "Fastapi Measurement Data Put",
"description": "Merge the measurement data given as datetime data into EOS measurements.",
"operationId": "fastapi_measurement_data_put_v1_measurement_data_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PydanticDateTimeData"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v1/prediction/keys": {
"get": {
"summary": "Fastapi Prediction Keys Get",
"description": "Get a list of available prediction keys.",
"operationId": "fastapi_prediction_keys_get_v1_prediction_keys_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Response Fastapi Prediction Keys Get V1 Prediction Keys Get"
}
}
}
}
}
}
},
"/v1/prediction/series": {
"get": {
"summary": "Fastapi Prediction Series Get",
"description": "Get prediction for given key within given date range as series.\n\nArgs:\n key (str): Prediction key\n start_datetime (Optional[str]): Starting datetime (inclusive).\n Defaults to start datetime of latest prediction.\n end_datetime (Optional[str]: Ending datetime (exclusive).\n Defaults to end datetime of latest prediction.",
"operationId": "fastapi_prediction_series_get_v1_prediction_series_get",
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "Prediction key.",
"title": "Key"
},
"description": "Prediction key."
},
{
"name": "start_datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Starting datetime (inclusive).",
"title": "Start Datetime"
},
"description": "Starting datetime (inclusive)."
},
{
"name": "end_datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ending datetime (exclusive).",
"title": "End Datetime"
},
"description": "Ending datetime (exclusive)."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PydanticDateTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v1/prediction/list": {
"get": {
"summary": "Fastapi Prediction List Get",
"description": "Get prediction for given key within given date range as value list.\n\nArgs:\n key (str): Prediction key\n start_datetime (Optional[str]): Starting datetime (inclusive).\n Defaults to start datetime of latest prediction.\n end_datetime (Optional[str]: Ending datetime (exclusive).\n Defaults to end datetime of latest prediction.\n interval (Optional[str]): Time duration for each interval.\n Defaults to 1 hour.",
"operationId": "fastapi_prediction_list_get_v1_prediction_list_get",
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "Prediction key.",
"title": "Key"
},
"description": "Prediction key."
},
{
"name": "start_datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Starting datetime (inclusive).",
"title": "Start Datetime"
},
"description": "Starting datetime (inclusive)."
},
{
"name": "end_datetime",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ending datetime (exclusive).",
"title": "End Datetime"
},
"description": "Ending datetime (exclusive)."
},
{
"name": "interval",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Time duration for each interval.",
"title": "Interval"
},
"description": "Time duration for each interval."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {},
"title": "Response Fastapi Prediction List Get V1 Prediction List Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v1/prediction/update": {
"post": {
"summary": "Fastapi Prediction Update",
"description": "Update predictions for all providers.\n\nArgs:\n force_update: Update data even if it is already cached.\n Defaults to False.\n force_enable: Update data even if provider is disabled.\n Defaults to False.",
"operationId": "fastapi_prediction_update_v1_prediction_update_post",
"parameters": [
{
"name": "force_update",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Force Update"
}
},
{
"name": "force_enable",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Force Enable"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v1/prediction/update/{provider_id}": {
"post": {
"summary": "Fastapi Prediction Update Provider",
"description": "Update predictions for given provider ID.\n\nArgs:\n provider_id: ID of provider to update.\n force_update: Update data even if it is already cached.\n Defaults to False.\n force_enable: Update data even if provider is disabled.\n Defaults to False.",
"operationId": "fastapi_prediction_update_provider_v1_prediction_update__provider_id__post",
"parameters": [
{
"name": "provider_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Provider Id"
}
},
{
"name": "force_update",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Force Update"
}
},
{
"name": "force_enable",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Force Enable"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/strompreis": {
"get": {
"summary": "Fastapi Strompreis",
"description": "Deprecated: Electricity Market Price Prediction per Wh (\u20ac/Wh).\n\nElectricity prices start at 00.00.00 today and are provided for 48 hours.\nIf no prices are available the missing ones at the start of the series are\nfilled with the first available price.\n\nNote:\n Electricity price charges are added.\n\nNote:\n Set ElecPriceAkkudoktor as elecprice_provider, then update data with\n '/v1/prediction/update'\n and then request data with\n '/v1/prediction/list?key=elecprice_marketprice_wh' or\n '/v1/prediction/list?key=elecprice_marketprice_kwh' instead.",
"operationId": "fastapi_strompreis_strompreis_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"items": {
"type": "number"
},
"type": "array",
"title": "Response Fastapi Strompreis Strompreis Get"
}
}
}
}
}
}
},
"/gesamtlast": {
"post": {
"summary": "Fastapi Gesamtlast",
"description": "Deprecated: Total Load Prediction with adjustment.\n\nEndpoint to handle total load prediction adjusted by latest measured data.\n\nTotal load prediction starts at 00.00.00 today and is provided for 48 hours.\nIf no prediction values are available the missing ones at the start of the series are\nfilled with the first available prediction value.\n\nNote:\n Use '/v1/prediction/list?key=load_mean_adjusted' instead.\n Load energy meter readings to be added to EOS measurement by:\n '/v1/measurement/load-mr/value/by-name' or\n '/v1/measurement/value'",
"operationId": "fastapi_gesamtlast_gesamtlast_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GesamtlastRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"items": {
"type": "number"
},
"type": "array",
"title": "Response Fastapi Gesamtlast Gesamtlast Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/gesamtlast_simple": {
"get": {
"summary": "Fastapi Gesamtlast Simple",
"description": "Deprecated: Total Load Prediction.\n\nEndpoint to handle total load prediction.\n\nTotal load prediction starts at 00.00.00 today and is provided for 48 hours.\nIf no prediction values are available the missing ones at the start of the series are\nfilled with the first available prediction value.\n\nArgs:\n year_energy (float): Yearly energy consumption in Wh.\n\nNote:\n Set LoadAkkudoktor as load_provider, then update data with\n '/v1/prediction/update'\n and then request data with\n '/v1/prediction/list?key=load_mean' instead.",
"operationId": "fastapi_gesamtlast_simple_gesamtlast_simple_get",
"parameters": [
{
"name": "year_energy",
"in": "query",
"required": true,
"schema": {
"type": "number",
"title": "Year Energy"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "number"
},
"title": "Response Fastapi Gesamtlast Simple Gesamtlast Simple Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/pvforecast": {
"get": {
"summary": "Fastapi Pvforecast",
"description": "Deprecated: PV Forecast Prediction.\n\nEndpoint to handle PV forecast prediction.\n\nPVForecast starts at 00.00.00 today and is provided for 48 hours.\nIf no forecast values are available the missing ones at the start of the series are\nfilled with the first available forecast value.\n\nNote:\n Set PVForecastAkkudoktor as pvforecast_provider, then update data with\n '/v1/prediction/update'\n and then request data with\n '/v1/prediction/list?key=pvforecast_ac_power' and\n '/v1/prediction/list?key=pvforecastakkudoktor_temp_air' instead.",
"operationId": "fastapi_pvforecast_pvforecast_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForecastResponse"
}
}
}
}
}
}
},
"/optimize": {
"post": {
"summary": "Fastapi Optimize",
"operationId": "fastapi_optimize_optimize_post",
"parameters": [
{
"name": "start_hour",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Defaults to current hour of the day.",
"title": "Start Hour"
},
"description": "Defaults to current hour of the day."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OptimizationParameters"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OptimizeResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/visualization_results.pdf": {
"get": {
"summary": "Get Pdf",
"operationId": "get_pdf_visualization_results_pdf_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/pdf": {
"schema": {
"type": "string"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"ConfigEOS": {
"properties": {
"server_eos_host": {
"anyOf": [
{
"type": "string",
"format": "ipvanyaddress"
},
{
"type": "null"
}
],
"title": "Server Eos Host",
"description": "EOS server IP address.",
"default": "0.0.0.0"
},
"server_eos_port": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Server Eos Port",
"description": "EOS server IP port number.",
"default": 8503
},
"server_eos_verbose": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Server Eos Verbose",
"description": "Enable debug output",
"default": false
},
"server_eos_startup_eosdash": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Server Eos Startup Eosdash",
"description": "EOS server to start EOSdash server.",
"default": true
},
"server_eosdash_host": {
"anyOf": [
{
"type": "string",
"format": "ipvanyaddress"
},
{
"type": "null"
}
],
"title": "Server Eosdash Host",
"description": "EOSdash server IP address.",
"default": "0.0.0.0"
},
"server_eosdash_port": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Server Eosdash Port",
"description": "EOSdash server IP port number.",
"default": 8504
},
"weatherimport_file_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Weatherimport File Path",
"description": "Path to the file to import weather data from."
},
"weatherimport_json": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Weatherimport Json",
"description": "JSON string, dictionary of weather forecast value lists."
},
"weather_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Weather Provider",
"description": "Weather provider id of provider to be used."
},
"pvforecastimport_file_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Pvforecastimport File Path",
"description": "Path to the file to import PV forecast data from."
},
"pvforecastimport_json": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecastimport Json",
"description": "JSON string, dictionary of PV forecast value lists."
},
"pvforecast_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast Provider",
"description": "PVForecast provider id of provider to be used."
},
"pvforecast0_surface_tilt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Surface Tilt",
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking."
},
"pvforecast0_surface_azimuth": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Surface Azimuth",
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)."
},
"pvforecast0_userhorizon": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Userhorizon",
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north."
},
"pvforecast0_peakpower": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Peakpower",
"description": "Nominal power of PV system in kW."
},
"pvforecast0_pvtechchoice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Pvtechchoice",
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'.",
"default": "crystSi"
},
"pvforecast0_mountingplace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Mountingplace",
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated.",
"default": "free"
},
"pvforecast0_loss": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Loss",
"description": "Sum of PV system losses in percent",
"default": 14.0
},
"pvforecast0_trackingtype": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Trackingtype",
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south."
},
"pvforecast0_optimal_surface_tilt": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Optimal Surface Tilt",
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking.",
"default": false
},
"pvforecast0_optimalangles": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Optimalangles",
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking.",
"default": false
},
"pvforecast0_albedo": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Albedo",
"description": "Proportion of the light hitting the ground that it reflects back."
},
"pvforecast0_module_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Module Model",
"description": "Model of the PV modules of this plane."
},
"pvforecast0_inverter_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Inverter Model",
"description": "Model of the inverter of this plane."
},
"pvforecast0_inverter_paco": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Inverter Paco",
"description": "AC power rating of the inverter. [W]"
},
"pvforecast0_modules_per_string": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Modules Per String",
"description": "Number of the PV modules of the strings of this plane."
},
"pvforecast0_strings_per_inverter": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Strings Per Inverter",
"description": "Number of the strings of the inverter of this plane."
},
"pvforecast1_surface_tilt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Surface Tilt",
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking."
},
"pvforecast1_surface_azimuth": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Surface Azimuth",
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)."
},
"pvforecast1_userhorizon": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Userhorizon",
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north."
},
"pvforecast1_peakpower": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Peakpower",
"description": "Nominal power of PV system in kW."
},
"pvforecast1_pvtechchoice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Pvtechchoice",
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'.",
"default": "crystSi"
},
"pvforecast1_mountingplace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Mountingplace",
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated.",
"default": "free"
},
"pvforecast1_loss": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Loss",
"description": "Sum of PV system losses in percent",
"default": 14.0
},
"pvforecast1_trackingtype": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Trackingtype",
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south."
},
"pvforecast1_optimal_surface_tilt": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Optimal Surface Tilt",
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking.",
"default": false
},
"pvforecast1_optimalangles": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Optimalangles",
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking.",
"default": false
},
"pvforecast1_albedo": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Albedo",
"description": "Proportion of the light hitting the ground that it reflects back."
},
"pvforecast1_module_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Module Model",
"description": "Model of the PV modules of this plane."
},
"pvforecast1_inverter_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Inverter Model",
"description": "Model of the inverter of this plane."
},
"pvforecast1_inverter_paco": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Inverter Paco",
"description": "AC power rating of the inverter. [W]"
},
"pvforecast1_modules_per_string": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Modules Per String",
"description": "Number of the PV modules of the strings of this plane."
},
"pvforecast1_strings_per_inverter": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Strings Per Inverter",
"description": "Number of the strings of the inverter of this plane."
},
"pvforecast2_surface_tilt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Surface Tilt",
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking."
},
"pvforecast2_surface_azimuth": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Surface Azimuth",
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)."
},
"pvforecast2_userhorizon": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Userhorizon",
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north."
},
"pvforecast2_peakpower": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Peakpower",
"description": "Nominal power of PV system in kW."
},
"pvforecast2_pvtechchoice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Pvtechchoice",
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'.",
"default": "crystSi"
},
"pvforecast2_mountingplace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Mountingplace",
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated.",
"default": "free"
},
"pvforecast2_loss": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Loss",
"description": "Sum of PV system losses in percent",
"default": 14.0
},
"pvforecast2_trackingtype": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Trackingtype",
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south."
},
"pvforecast2_optimal_surface_tilt": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Optimal Surface Tilt",
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking.",
"default": false
},
"pvforecast2_optimalangles": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Optimalangles",
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking.",
"default": false
},
"pvforecast2_albedo": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Albedo",
"description": "Proportion of the light hitting the ground that it reflects back."
},
"pvforecast2_module_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Module Model",
"description": "Model of the PV modules of this plane."
},
"pvforecast2_inverter_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Inverter Model",
"description": "Model of the inverter of this plane."
},
"pvforecast2_inverter_paco": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Inverter Paco",
"description": "AC power rating of the inverter. [W]"
},
"pvforecast2_modules_per_string": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Modules Per String",
"description": "Number of the PV modules of the strings of this plane."
},
"pvforecast2_strings_per_inverter": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Strings Per Inverter",
"description": "Number of the strings of the inverter of this plane."
},
"pvforecast3_surface_tilt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Surface Tilt",
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking."
},
"pvforecast3_surface_azimuth": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Surface Azimuth",
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)."
},
"pvforecast3_userhorizon": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Userhorizon",
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north."
},
"pvforecast3_peakpower": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Peakpower",
"description": "Nominal power of PV system in kW."
},
"pvforecast3_pvtechchoice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Pvtechchoice",
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'.",
"default": "crystSi"
},
"pvforecast3_mountingplace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Mountingplace",
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated.",
"default": "free"
},
"pvforecast3_loss": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Loss",
"description": "Sum of PV system losses in percent",
"default": 14.0
},
"pvforecast3_trackingtype": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Trackingtype",
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south."
},
"pvforecast3_optimal_surface_tilt": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Optimal Surface Tilt",
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking.",
"default": false
},
"pvforecast3_optimalangles": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Optimalangles",
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking.",
"default": false
},
"pvforecast3_albedo": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Albedo",
"description": "Proportion of the light hitting the ground that it reflects back."
},
"pvforecast3_module_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Module Model",
"description": "Model of the PV modules of this plane."
},
"pvforecast3_inverter_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Inverter Model",
"description": "Model of the inverter of this plane."
},
"pvforecast3_inverter_paco": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Inverter Paco",
"description": "AC power rating of the inverter. [W]"
},
"pvforecast3_modules_per_string": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Modules Per String",
"description": "Number of the PV modules of the strings of this plane."
},
"pvforecast3_strings_per_inverter": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Strings Per Inverter",
"description": "Number of the strings of the inverter of this plane."
},
"pvforecast4_surface_tilt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Surface Tilt",
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking."
},
"pvforecast4_surface_azimuth": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Surface Azimuth",
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)."
},
"pvforecast4_userhorizon": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Userhorizon",
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north."
},
"pvforecast4_peakpower": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Peakpower",
"description": "Nominal power of PV system in kW."
},
"pvforecast4_pvtechchoice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Pvtechchoice",
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'.",
"default": "crystSi"
},
"pvforecast4_mountingplace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Mountingplace",
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated.",
"default": "free"
},
"pvforecast4_loss": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Loss",
"description": "Sum of PV system losses in percent",
"default": 14.0
},
"pvforecast4_trackingtype": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Trackingtype",
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south."
},
"pvforecast4_optimal_surface_tilt": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Optimal Surface Tilt",
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking.",
"default": false
},
"pvforecast4_optimalangles": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Optimalangles",
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking.",
"default": false
},
"pvforecast4_albedo": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Albedo",
"description": "Proportion of the light hitting the ground that it reflects back."
},
"pvforecast4_module_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Module Model",
"description": "Model of the PV modules of this plane."
},
"pvforecast4_inverter_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Inverter Model",
"description": "Model of the inverter of this plane."
},
"pvforecast4_inverter_paco": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Inverter Paco",
"description": "AC power rating of the inverter. [W]"
},
"pvforecast4_modules_per_string": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Modules Per String",
"description": "Number of the PV modules of the strings of this plane."
},
"pvforecast4_strings_per_inverter": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Strings Per Inverter",
"description": "Number of the strings of the inverter of this plane."
},
"pvforecast5_surface_tilt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Surface Tilt",
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking."
},
"pvforecast5_surface_azimuth": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Surface Azimuth",
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)."
},
"pvforecast5_userhorizon": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Userhorizon",
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north."
},
"pvforecast5_peakpower": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Peakpower",
"description": "Nominal power of PV system in kW."
},
"pvforecast5_pvtechchoice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Pvtechchoice",
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'.",
"default": "crystSi"
},
"pvforecast5_mountingplace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Mountingplace",
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated.",
"default": "free"
},
"pvforecast5_loss": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Loss",
"description": "Sum of PV system losses in percent",
"default": 14.0
},
"pvforecast5_trackingtype": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Trackingtype",
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south."
},
"pvforecast5_optimal_surface_tilt": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Optimal Surface Tilt",
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking.",
"default": false
},
"pvforecast5_optimalangles": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Optimalangles",
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking.",
"default": false
},
"pvforecast5_albedo": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Albedo",
"description": "Proportion of the light hitting the ground that it reflects back."
},
"pvforecast5_module_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Module Model",
"description": "Model of the PV modules of this plane."
},
"pvforecast5_inverter_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Inverter Model",
"description": "Model of the inverter of this plane."
},
"pvforecast5_inverter_paco": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Inverter Paco",
"description": "AC power rating of the inverter. [W]"
},
"pvforecast5_modules_per_string": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Modules Per String",
"description": "Number of the PV modules of the strings of this plane."
},
"pvforecast5_strings_per_inverter": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Strings Per Inverter",
"description": "Number of the strings of the inverter of this plane."
},
"load_import_file_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Load Import File Path",
"description": "Path to the file to import load data from."
},
"load_import_json": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Load Import Json",
"description": "JSON string, dictionary of load forecast value lists."
},
"loadakkudoktor_year_energy": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Loadakkudoktor Year Energy",
"description": "Yearly energy consumption (kWh)."
},
"load_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Load Provider",
"description": "Load provider id of provider to be used."
},
"elecpriceimport_file_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Elecpriceimport File Path",
"description": "Path to the file to import elecprice data from."
},
"elecpriceimport_json": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Elecpriceimport Json",
"description": "JSON string, dictionary of electricity price forecast value lists."
},
"elecprice_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Elecprice Provider",
"description": "Electricity price provider id of provider to be used."
},
"elecprice_charges_kwh": {
"anyOf": [
{
"type": "number",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Elecprice Charges Kwh",
"description": "Electricity price charges (\u20ac/kWh)."
},
"prediction_hours": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Prediction Hours",
"description": "Number of hours into the future for predictions",
"default": 48
},
"prediction_historic_hours": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Prediction Historic Hours",
"description": "Number of hours into the past for historical predictions data",
"default": 48
},
"latitude": {
"anyOf": [
{
"type": "number",
"maximum": 90.0,
"minimum": -90.0
},
{
"type": "null"
}
],
"title": "Latitude",
"description": "Latitude in decimal degrees, between -90 and 90, north is positive (ISO 19115) (\u00b0)"
},
"longitude": {
"anyOf": [
{
"type": "number",
"maximum": 180.0,
"minimum": -180.0
},
{
"type": "null"
}
],
"title": "Longitude",
"description": "Longitude in decimal degrees, within -180 to 180 (\u00b0)"
},
"optimization_hours": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Optimization Hours",
"description": "Number of hours into the future for optimizations.",
"default": 24
},
"optimization_penalty": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Optimization Penalty",
"description": "Penalty factor used in optimization.",
"default": 10
},
"optimization_ev_available_charge_rates_percent": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Optimization Ev Available Charge Rates Percent",
"description": "Charge rates available for the EV in percent of maximum charge.",
"default": [
0.0,
0.375,
0.5,
0.625,
0.75,
0.875,
1.0
]
},
"measurement_load0_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Measurement Load0 Name",
"description": "Name of the load0 source (e.g. 'Household', 'Heat Pump')"
},
"measurement_load1_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Measurement Load1 Name",
"description": "Name of the load1 source (e.g. 'Household', 'Heat Pump')"
},
"measurement_load2_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Measurement Load2 Name",
"description": "Name of the load2 source (e.g. 'Household', 'Heat Pump')"
},
"measurement_load3_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Measurement Load3 Name",
"description": "Name of the load3 source (e.g. 'Household', 'Heat Pump')"
},
"measurement_load4_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Measurement Load4 Name",
"description": "Name of the load4 source (e.g. 'Household', 'Heat Pump')"
},
"battery_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Battery Provider",
"description": "Id of Battery simulation provider."
},
"battery_capacity": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Battery Capacity",
"description": "Battery capacity [Wh]."
},
"battery_initial_soc": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Battery Initial Soc",
"description": "Battery initial state of charge [%]."
},
"battery_soc_min": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Battery Soc Min",
"description": "Battery minimum state of charge [%]."
},
"battery_soc_max": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Battery Soc Max",
"description": "Battery maximum state of charge [%]."
},
"battery_charging_efficiency": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Battery Charging Efficiency",
"description": "Battery charging efficiency [%]."
},
"battery_discharging_efficiency": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Battery Discharging Efficiency",
"description": "Battery discharging efficiency [%]."
},
"battery_max_charging_power": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Battery Max Charging Power",
"description": "Battery maximum charge power [W]."
},
"bev_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Bev Provider",
"description": "Id of Battery Electric Vehicle simulation provider."
},
"bev_capacity": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Bev Capacity",
"description": "Battery Electric Vehicle capacity [Wh]."
},
"bev_initial_soc": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Bev Initial Soc",
"description": "Battery Electric Vehicle initial state of charge [%]."
},
"bev_soc_max": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Bev Soc Max",
"description": "Battery Electric Vehicle maximum state of charge [%]."
},
"bev_charging_efficiency": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Bev Charging Efficiency",
"description": "Battery Electric Vehicle charging efficiency [%]."
},
"bev_discharging_efficiency": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Bev Discharging Efficiency",
"description": "Battery Electric Vehicle discharging efficiency [%]."
},
"bev_max_charging_power": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Bev Max Charging Power",
"description": "Battery Electric Vehicle maximum charge power [W]."
},
"dishwasher_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dishwasher Provider",
"description": "Id of Dish Washer simulation provider."
},
"dishwasher_consumption": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Dishwasher Consumption",
"description": "Dish Washer energy consumption [Wh]."
},
"dishwasher_duration": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Dishwasher Duration",
"description": "Dish Washer usage duration [h]."
},
"inverter_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Inverter Provider",
"description": "Id of PV Inverter simulation provider."
},
"inverter_power_max": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Inverter Power Max",
"description": "Inverter maximum power [W]."
},
"logging_level_default": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Logging Level Default",
"description": "EOS default logging level."
},
"data_folder_path": {
"anyOf": [
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Data Folder Path",
"description": "Path to EOS data directory."
},
"data_output_subpath": {
"anyOf": [
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Data Output Subpath",
"description": "Sub-path for the EOS output data directory.",
"default": "output"
},
"data_cache_subpath": {
"anyOf": [
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Data Cache Subpath",
"description": "Sub-path for the EOS cache data directory.",
"default": "cache"
},
"pvforecast_planes": {
"items": {
"type": "string"
},
"type": "array",
"title": "Pvforecast Planes",
"description": "Compute a list of active planes.",
"readOnly": true
},
"pvforecast_planes_peakpower": {
"items": {
"type": "number"
},
"type": "array",
"title": "Pvforecast Planes Peakpower",
"description": "Compute a list of the peak power per active planes.",
"readOnly": true
},
"pvforecast_planes_azimuth": {
"items": {
"type": "number"
},
"type": "array",
"title": "Pvforecast Planes Azimuth",
"description": "Compute a list of the azimuths per active planes.",
"readOnly": true
},
"pvforecast_planes_tilt": {
"items": {
"type": "number"
},
"type": "array",
"title": "Pvforecast Planes Tilt",
"description": "Compute a list of the tilts per active planes.",
"readOnly": true
},
"pvforecast_planes_userhorizon": {
"title": "Pvforecast Planes Userhorizon",
"description": "Compute a list of the user horizon per active planes.",
"readOnly": true
},
"pvforecast_planes_inverter_paco": {
"title": "Pvforecast Planes Inverter Paco",
"description": "Compute a list of the maximum power rating of the inverter per active planes.",
"readOnly": true
},
"timezone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Timezone",
"description": "Compute timezone based on latitude and longitude.",
"readOnly": true
},
"logging_level_root": {
"type": "string",
"title": "Logging Level Root",
"description": "Root logger logging level.",
"readOnly": true
},
"data_output_path": {
"anyOf": [
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Data Output Path",
"description": "Compute data_output_path based on data_folder_path.",
"readOnly": true
},
"data_cache_path": {
"anyOf": [
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Data Cache Path",
"description": "Compute data_cache_path based on data_folder_path.",
"readOnly": true
},
"config_folder_path": {
"anyOf": [
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Config Folder Path",
"description": "Path to EOS configuration directory.",
"readOnly": true
},
"config_file_path": {
"anyOf": [
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Config File Path",
"description": "Path to EOS configuration file.",
"readOnly": true
},
"config_default_file_path": {
"type": "string",
"format": "path",
"title": "Config Default File Path",
"description": "Compute the default config file path.",
"readOnly": true
},
"package_root_path": {
"type": "string",
"format": "path",
"title": "Package Root Path",
"description": "Compute the package root path.",
"readOnly": true
},
"config_keys": {
"items": {
"type": "string"
},
"type": "array",
"title": "Config Keys",
"description": "Returns the keys of all fields in the configuration.",
"readOnly": true
},
"config_keys_read_only": {
"items": {
"type": "string"
},
"type": "array",
"title": "Config Keys Read Only",
"description": "Returns the keys of all read only fields in the configuration.",
"readOnly": true
}
},
"type": "object",
"required": [
"pvforecast_planes",
"pvforecast_planes_peakpower",
"pvforecast_planes_azimuth",
"pvforecast_planes_tilt",
"pvforecast_planes_userhorizon",
"pvforecast_planes_inverter_paco",
"timezone",
"logging_level_root",
"data_output_path",
"data_cache_path",
"config_folder_path",
"config_file_path",
"config_default_file_path",
"package_root_path",
"config_keys",
"config_keys_read_only"
],
"title": "ConfigEOS",
"description": "Singleton configuration handler for the EOS application.\n\nConfigEOS extends `SettingsEOS` with support for default configuration paths and automatic\ninitialization.\n\n`ConfigEOS` ensures that only one instance of the class is created throughout the application,\nallowing consistent access to EOS configuration settings. This singleton instance loads\nconfiguration data from a predefined set of directories or creates a default configuration if\nnone is found.\n\nInitialization Process:\n - Upon instantiation, the singleton instance attempts to load a configuration file in this order:\n 1. The directory specified by the `EOS_CONFIG_DIR` environment variable\n 2. The directory specified by the `EOS_DIR` environment variable.\n 3. A platform specific default directory for EOS.\n 4. The current working directory.\n - The first available configuration file found in these directories is loaded.\n - If no configuration file is found, a default configuration file is created in the platform\n specific default directory, and default settings are loaded into it.\n\nAttributes from the loaded configuration are accessible directly as instance attributes of\n`ConfigEOS`, providing a centralized, shared configuration object for EOS.\n\nSingleton Behavior:\n - This class uses the `SingletonMixin` to ensure that all requests for `ConfigEOS` return\n the same instance, which contains the most up-to-date configuration. Modifying the configuration\n in one part of the application reflects across all references to this class.\n\nAttributes:\n _settings (ClassVar[SettingsEOS]): Holds application-wide settings.\n _file_settings (ClassVar[SettingsEOS]): Stores configuration loaded from file.\n config_folder_path (Optional[Path]): Path to the configuration directory.\n config_file_path (Optional[Path]): Path to the configuration file.\n\nRaises:\n FileNotFoundError: If no configuration file is found, and creating a default configuration fails.\n\nExample:\n To initialize and access configuration attributes (only one instance is created):\n ```python\n config_eos = ConfigEOS() # Always returns the same instance\n print(config_eos.prediction_hours) # Access a setting from the loaded configuration\n ```"
},
"ElectricVehicleParameters": {
"properties": {
"capacity_wh": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Capacity Wh",
"description": "An integer representing the capacity of the battery in watt-hours."
},
"charging_efficiency": {
"type": "number",
"maximum": 1.0,
"exclusiveMinimum": 0.0,
"title": "Charging Efficiency",
"description": "A float representing the charging efficiency of the battery.",
"default": 0.88
},
"discharging_efficiency": {
"type": "number",
"title": "Discharging Efficiency",
"default": 1.0
},
"max_charge_power_w": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Max Charge Power W",
"description": "Maximum charging power in watts.",
"default": 5000
},
"initial_soc_percentage": {
"type": "integer",
"maximum": 100.0,
"minimum": 0.0,
"title": "Initial Soc Percentage",
"description": "An integer representing the current state of charge (SOC) of the battery in percentage.",
"default": 0
},
"min_soc_percentage": {
"type": "integer",
"maximum": 100.0,
"minimum": 0.0,
"title": "Min Soc Percentage",
"description": "An integer representing the minimum state of charge (SOC) of the battery in percentage.",
"default": 0
},
"max_soc_percentage": {
"type": "integer",
"maximum": 100.0,
"minimum": 0.0,
"title": "Max Soc Percentage",
"description": "An integer representing the maximum state of charge (SOC) of the battery in percentage.",
"default": 100
}
},
"additionalProperties": false,
"type": "object",
"required": [
"capacity_wh"
],
"title": "ElectricVehicleParameters",
"description": "Parameters specific to an electric vehicle (EV)."
},
"ElectricVehicleResult": {
"properties": {
"charge_array": {
"items": {
"type": "number"
},
"type": "array",
"title": "Charge Array",
"description": "Hourly charging status (0 for no charging, 1 for charging)."
},
"discharge_array": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Discharge Array",
"description": "Hourly discharging status (0 for no discharging, 1 for discharging)."
},
"discharging_efficiency": {
"type": "number",
"title": "Discharging Efficiency",
"description": "The discharge efficiency as a float.."
},
"hours": {
"type": "integer",
"title": "Hours",
"description": "Number of hours in the simulation."
},
"capacity_wh": {
"type": "integer",
"title": "Capacity Wh",
"description": "Capacity of the EV\u2019s battery in watt-hours."
},
"charging_efficiency": {
"type": "number",
"title": "Charging Efficiency",
"description": "Charging efficiency as a float.."
},
"max_charge_power_w": {
"type": "integer",
"title": "Max Charge Power W",
"description": "Maximum charging power in watts."
},
"soc_wh": {
"type": "number",
"title": "Soc Wh",
"description": "State of charge of the battery in watt-hours at the start of the simulation."
},
"initial_soc_percentage": {
"type": "integer",
"title": "Initial Soc Percentage",
"description": "State of charge at the start of the simulation in percentage."
}
},
"type": "object",
"required": [
"charge_array",
"discharge_array",
"discharging_efficiency",
"hours",
"capacity_wh",
"charging_efficiency",
"max_charge_power_w",
"soc_wh",
"initial_soc_percentage"
],
"title": "ElectricVehicleResult",
"description": "Result class containing information related to the electric vehicle's charging and discharging behavior."
},
"EnergieManagementSystemParameters": {
"properties": {
"pv_prognose_wh": {
"items": {
"type": "number"
},
"type": "array",
"title": "Pv Prognose Wh",
"description": "An array of floats representing the forecasted photovoltaic output in watts for different time intervals."
},
"strompreis_euro_pro_wh": {
"items": {
"type": "number"
},
"type": "array",
"title": "Strompreis Euro Pro Wh",
"description": "An array of floats representing the electricity price in euros per watt-hour for different time intervals."
},
"einspeiseverguetung_euro_pro_wh": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "number"
}
],
"title": "Einspeiseverguetung Euro Pro Wh",
"description": "A float or array of floats representing the feed-in compensation in euros per watt-hour."
},
"preis_euro_pro_wh_akku": {
"type": "number",
"title": "Preis Euro Pro Wh Akku",
"description": "A float representing the cost of battery energy per watt-hour."
},
"gesamtlast": {
"items": {
"type": "number"
},
"type": "array",
"title": "Gesamtlast",
"description": "An array of floats representing the total load (consumption) in watts for different time intervals."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"pv_prognose_wh",
"strompreis_euro_pro_wh",
"einspeiseverguetung_euro_pro_wh",
"preis_euro_pro_wh_akku",
"gesamtlast"
],
"title": "EnergieManagementSystemParameters"
},
"ForecastResponse": {
"properties": {
"temperature": {
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Temperature"
},
"pvpower": {
"items": {
"type": "number"
},
"type": "array",
"title": "Pvpower"
}
},
"type": "object",
"required": [
"temperature",
"pvpower"
],
"title": "ForecastResponse"
},
"GesamtlastRequest": {
"properties": {
"year_energy": {
"type": "number",
"title": "Year Energy"
},
"measured_data": {
"items": {
"type": "object"
},
"type": "array",
"title": "Measured Data"
},
"hours": {
"type": "integer",
"title": "Hours"
}
},
"type": "object",
"required": [
"year_energy",
"measured_data",
"hours"
],
"title": "GesamtlastRequest"
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"HomeApplianceParameters": {
"properties": {
"consumption_wh": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Consumption Wh",
"description": "An integer representing the energy consumption of a household device in watt-hours."
},
"duration_h": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Duration H",
"description": "An integer representing the usage duration of a household device in hours."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"consumption_wh",
"duration_h"
],
"title": "HomeApplianceParameters"
},
"InverterParameters": {
"properties": {
"max_power_wh": {
"type": "number",
"exclusiveMinimum": 0.0,
"title": "Max Power Wh"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"max_power_wh"
],
"title": "InverterParameters"
},
"OptimizationParameters": {
"properties": {
"ems": {
"$ref": "#/components/schemas/EnergieManagementSystemParameters"
},
"pv_akku": {
"anyOf": [
{
"$ref": "#/components/schemas/SolarPanelBatteryParameters"
},
{
"type": "null"
}
]
},
"inverter": {
"anyOf": [
{
"$ref": "#/components/schemas/InverterParameters"
},
{
"type": "null"
}
]
},
"eauto": {
"anyOf": [
{
"$ref": "#/components/schemas/ElectricVehicleParameters"
},
{
"type": "null"
}
]
},
"dishwasher": {
"anyOf": [
{
"$ref": "#/components/schemas/HomeApplianceParameters"
},
{
"type": "null"
}
]
},
"temperature_forecast": {
"anyOf": [
{
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Temperature Forecast",
"description": "An array of floats representing the temperature forecast in degrees Celsius for different time intervals."
},
"start_solution": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Start Solution",
"description": "Can be `null` or contain a previous solution (if available)."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"ems",
"pv_akku",
"inverter",
"eauto"
],
"title": "OptimizationParameters"
},
"OptimizeResponse": {
"properties": {
"ac_charge": {
"items": {
"type": "number"
},
"type": "array",
"title": "Ac Charge",
"description": "Array with AC charging values as relative power (0-1), other values set to 0."
},
"dc_charge": {
"items": {
"type": "number"
},
"type": "array",
"title": "Dc Charge",
"description": "Array with DC charging values as relative power (0-1), other values set to 0."
},
"discharge_allowed": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Discharge Allowed",
"description": "Array with discharge values (1 for discharge, 0 otherwise)."
},
"eautocharge_hours_float": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Eautocharge Hours Float",
"description": "TBD"
},
"result": {
"$ref": "#/components/schemas/SimulationResult"
},
"eauto_obj": {
"anyOf": [
{
"$ref": "#/components/schemas/ElectricVehicleResult"
},
{
"type": "null"
}
]
},
"start_solution": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Start Solution",
"description": "An array of binary values (0 or 1) representing a possible starting solution for the simulation."
},
"washingstart": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Washingstart",
"description": "Can be `null` or contain an object representing the start of washing (if applicable)."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"ac_charge",
"dc_charge",
"discharge_allowed",
"eautocharge_hours_float",
"result",
"eauto_obj"
],
"title": "OptimizeResponse",
"description": "**Note**: The first value of \"Last_Wh_per_hour\", \"Netzeinspeisung_Wh_per_hour\", and \"Netzbezug_Wh_per_hour\", will be set to null in the JSON output and represented as NaN or None in the corresponding classes' data returns. This approach is adopted to ensure that the current hour's processing remains unchanged."
},
"PydanticDateTimeData": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "array"
}
]
},
"type": "object",
"title": "PydanticDateTimeData",
"description": "Pydantic model for time series data with consistent value lengths.\n\nThis model validates a dictionary where:\n- Keys are strings representing data series names\n- Values are lists of numeric or string values\n- Special keys 'start_datetime' and 'interval' can contain string values\nfor time series indexing\n- All value lists must have the same length\n\nExample:\n {\n \"start_datetime\": \"2024-01-01 00:00:00\", # optional\n \"interval\": \"1 Hour\", # optional\n \"load_mean\": [20.5, 21.0, 22.1],\n \"load_min\": [18.5, 19.0, 20.1]\n }"
},
"PydanticDateTimeDataFrame": {
"properties": {
"data": {
"additionalProperties": {
"type": "object"
},
"type": "object",
"title": "Data"
},
"dtypes": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Dtypes"
},
"tz": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Tz",
"description": "Timezone for datetime values"
},
"datetime_columns": {
"items": {
"type": "string"
},
"type": "array",
"title": "Datetime Columns",
"description": "Columns to be treated as datetime"
}
},
"type": "object",
"required": [
"data"
],
"title": "PydanticDateTimeDataFrame",
"description": "Pydantic model for validating pandas DataFrame data with datetime index."
},
"PydanticDateTimeSeries": {
"properties": {
"data": {
"type": "object",
"title": "Data"
},
"dtype": {
"type": "string",
"title": "Dtype",
"default": "float64"
},
"tz": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Tz"
}
},
"type": "object",
"required": [
"data"
],
"title": "PydanticDateTimeSeries",
"description": "Pydantic model for validating pandas Series with datetime index in JSON format.\n\nThis model handles Series data serialized with orient='index', where the keys are\ndatetime strings and values are the series values. Provides validation and\nconversion between JSON and pandas Series with datetime index.\n\nAttributes:\n data (Dict[str, Any]): Dictionary mapping datetime strings to values.\n dtype (str): The data type of the series values.\n tz (str | None): Timezone name if the datetime index is timezone-aware."
},
"SettingsEOS": {
"properties": {
"server_eos_host": {
"anyOf": [
{
"type": "string",
"format": "ipvanyaddress"
},
{
"type": "null"
}
],
"title": "Server Eos Host",
"description": "EOS server IP address.",
"default": "0.0.0.0"
},
"server_eos_port": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Server Eos Port",
"description": "EOS server IP port number.",
"default": 8503
},
"server_eos_verbose": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Server Eos Verbose",
"description": "Enable debug output",
"default": false
},
"server_eos_startup_eosdash": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Server Eos Startup Eosdash",
"description": "EOS server to start EOSdash server.",
"default": true
},
"server_eosdash_host": {
"anyOf": [
{
"type": "string",
"format": "ipvanyaddress"
},
{
"type": "null"
}
],
"title": "Server Eosdash Host",
"description": "EOSdash server IP address.",
"default": "0.0.0.0"
},
"server_eosdash_port": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Server Eosdash Port",
"description": "EOSdash server IP port number.",
"default": 8504
},
"weatherimport_file_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Weatherimport File Path",
"description": "Path to the file to import weather data from."
},
"weatherimport_json": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Weatherimport Json",
"description": "JSON string, dictionary of weather forecast value lists."
},
"weather_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Weather Provider",
"description": "Weather provider id of provider to be used."
},
"pvforecastimport_file_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Pvforecastimport File Path",
"description": "Path to the file to import PV forecast data from."
},
"pvforecastimport_json": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecastimport Json",
"description": "JSON string, dictionary of PV forecast value lists."
},
"pvforecast_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast Provider",
"description": "PVForecast provider id of provider to be used."
},
"pvforecast0_surface_tilt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Surface Tilt",
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking."
},
"pvforecast0_surface_azimuth": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Surface Azimuth",
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)."
},
"pvforecast0_userhorizon": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Userhorizon",
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north."
},
"pvforecast0_peakpower": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Peakpower",
"description": "Nominal power of PV system in kW."
},
"pvforecast0_pvtechchoice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Pvtechchoice",
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'.",
"default": "crystSi"
},
"pvforecast0_mountingplace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Mountingplace",
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated.",
"default": "free"
},
"pvforecast0_loss": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Loss",
"description": "Sum of PV system losses in percent",
"default": 14.0
},
"pvforecast0_trackingtype": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Trackingtype",
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south."
},
"pvforecast0_optimal_surface_tilt": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Optimal Surface Tilt",
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking.",
"default": false
},
"pvforecast0_optimalangles": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Optimalangles",
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking.",
"default": false
},
"pvforecast0_albedo": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Albedo",
"description": "Proportion of the light hitting the ground that it reflects back."
},
"pvforecast0_module_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Module Model",
"description": "Model of the PV modules of this plane."
},
"pvforecast0_inverter_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Inverter Model",
"description": "Model of the inverter of this plane."
},
"pvforecast0_inverter_paco": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Inverter Paco",
"description": "AC power rating of the inverter. [W]"
},
"pvforecast0_modules_per_string": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Modules Per String",
"description": "Number of the PV modules of the strings of this plane."
},
"pvforecast0_strings_per_inverter": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast0 Strings Per Inverter",
"description": "Number of the strings of the inverter of this plane."
},
"pvforecast1_surface_tilt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Surface Tilt",
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking."
},
"pvforecast1_surface_azimuth": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Surface Azimuth",
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)."
},
"pvforecast1_userhorizon": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Userhorizon",
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north."
},
"pvforecast1_peakpower": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Peakpower",
"description": "Nominal power of PV system in kW."
},
"pvforecast1_pvtechchoice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Pvtechchoice",
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'.",
"default": "crystSi"
},
"pvforecast1_mountingplace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Mountingplace",
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated.",
"default": "free"
},
"pvforecast1_loss": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Loss",
"description": "Sum of PV system losses in percent",
"default": 14.0
},
"pvforecast1_trackingtype": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Trackingtype",
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south."
},
"pvforecast1_optimal_surface_tilt": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Optimal Surface Tilt",
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking.",
"default": false
},
"pvforecast1_optimalangles": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Optimalangles",
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking.",
"default": false
},
"pvforecast1_albedo": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Albedo",
"description": "Proportion of the light hitting the ground that it reflects back."
},
"pvforecast1_module_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Module Model",
"description": "Model of the PV modules of this plane."
},
"pvforecast1_inverter_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Inverter Model",
"description": "Model of the inverter of this plane."
},
"pvforecast1_inverter_paco": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Inverter Paco",
"description": "AC power rating of the inverter. [W]"
},
"pvforecast1_modules_per_string": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Modules Per String",
"description": "Number of the PV modules of the strings of this plane."
},
"pvforecast1_strings_per_inverter": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast1 Strings Per Inverter",
"description": "Number of the strings of the inverter of this plane."
},
"pvforecast2_surface_tilt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Surface Tilt",
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking."
},
"pvforecast2_surface_azimuth": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Surface Azimuth",
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)."
},
"pvforecast2_userhorizon": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Userhorizon",
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north."
},
"pvforecast2_peakpower": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Peakpower",
"description": "Nominal power of PV system in kW."
},
"pvforecast2_pvtechchoice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Pvtechchoice",
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'.",
"default": "crystSi"
},
"pvforecast2_mountingplace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Mountingplace",
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated.",
"default": "free"
},
"pvforecast2_loss": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Loss",
"description": "Sum of PV system losses in percent",
"default": 14.0
},
"pvforecast2_trackingtype": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Trackingtype",
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south."
},
"pvforecast2_optimal_surface_tilt": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Optimal Surface Tilt",
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking.",
"default": false
},
"pvforecast2_optimalangles": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Optimalangles",
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking.",
"default": false
},
"pvforecast2_albedo": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Albedo",
"description": "Proportion of the light hitting the ground that it reflects back."
},
"pvforecast2_module_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Module Model",
"description": "Model of the PV modules of this plane."
},
"pvforecast2_inverter_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Inverter Model",
"description": "Model of the inverter of this plane."
},
"pvforecast2_inverter_paco": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Inverter Paco",
"description": "AC power rating of the inverter. [W]"
},
"pvforecast2_modules_per_string": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Modules Per String",
"description": "Number of the PV modules of the strings of this plane."
},
"pvforecast2_strings_per_inverter": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast2 Strings Per Inverter",
"description": "Number of the strings of the inverter of this plane."
},
"pvforecast3_surface_tilt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Surface Tilt",
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking."
},
"pvforecast3_surface_azimuth": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Surface Azimuth",
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)."
},
"pvforecast3_userhorizon": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Userhorizon",
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north."
},
"pvforecast3_peakpower": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Peakpower",
"description": "Nominal power of PV system in kW."
},
"pvforecast3_pvtechchoice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Pvtechchoice",
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'.",
"default": "crystSi"
},
"pvforecast3_mountingplace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Mountingplace",
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated.",
"default": "free"
},
"pvforecast3_loss": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Loss",
"description": "Sum of PV system losses in percent",
"default": 14.0
},
"pvforecast3_trackingtype": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Trackingtype",
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south."
},
"pvforecast3_optimal_surface_tilt": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Optimal Surface Tilt",
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking.",
"default": false
},
"pvforecast3_optimalangles": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Optimalangles",
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking.",
"default": false
},
"pvforecast3_albedo": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Albedo",
"description": "Proportion of the light hitting the ground that it reflects back."
},
"pvforecast3_module_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Module Model",
"description": "Model of the PV modules of this plane."
},
"pvforecast3_inverter_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Inverter Model",
"description": "Model of the inverter of this plane."
},
"pvforecast3_inverter_paco": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Inverter Paco",
"description": "AC power rating of the inverter. [W]"
},
"pvforecast3_modules_per_string": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Modules Per String",
"description": "Number of the PV modules of the strings of this plane."
},
"pvforecast3_strings_per_inverter": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast3 Strings Per Inverter",
"description": "Number of the strings of the inverter of this plane."
},
"pvforecast4_surface_tilt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Surface Tilt",
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking."
},
"pvforecast4_surface_azimuth": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Surface Azimuth",
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)."
},
"pvforecast4_userhorizon": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Userhorizon",
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north."
},
"pvforecast4_peakpower": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Peakpower",
"description": "Nominal power of PV system in kW."
},
"pvforecast4_pvtechchoice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Pvtechchoice",
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'.",
"default": "crystSi"
},
"pvforecast4_mountingplace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Mountingplace",
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated.",
"default": "free"
},
"pvforecast4_loss": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Loss",
"description": "Sum of PV system losses in percent",
"default": 14.0
},
"pvforecast4_trackingtype": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Trackingtype",
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south."
},
"pvforecast4_optimal_surface_tilt": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Optimal Surface Tilt",
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking.",
"default": false
},
"pvforecast4_optimalangles": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Optimalangles",
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking.",
"default": false
},
"pvforecast4_albedo": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Albedo",
"description": "Proportion of the light hitting the ground that it reflects back."
},
"pvforecast4_module_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Module Model",
"description": "Model of the PV modules of this plane."
},
"pvforecast4_inverter_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Inverter Model",
"description": "Model of the inverter of this plane."
},
"pvforecast4_inverter_paco": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Inverter Paco",
"description": "AC power rating of the inverter. [W]"
},
"pvforecast4_modules_per_string": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Modules Per String",
"description": "Number of the PV modules of the strings of this plane."
},
"pvforecast4_strings_per_inverter": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast4 Strings Per Inverter",
"description": "Number of the strings of the inverter of this plane."
},
"pvforecast5_surface_tilt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Surface Tilt",
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking."
},
"pvforecast5_surface_azimuth": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Surface Azimuth",
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)."
},
"pvforecast5_userhorizon": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Userhorizon",
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north."
},
"pvforecast5_peakpower": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Peakpower",
"description": "Nominal power of PV system in kW."
},
"pvforecast5_pvtechchoice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Pvtechchoice",
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'.",
"default": "crystSi"
},
"pvforecast5_mountingplace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Mountingplace",
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated.",
"default": "free"
},
"pvforecast5_loss": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Loss",
"description": "Sum of PV system losses in percent",
"default": 14.0
},
"pvforecast5_trackingtype": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Trackingtype",
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south."
},
"pvforecast5_optimal_surface_tilt": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Optimal Surface Tilt",
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking.",
"default": false
},
"pvforecast5_optimalangles": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Optimalangles",
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking.",
"default": false
},
"pvforecast5_albedo": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Albedo",
"description": "Proportion of the light hitting the ground that it reflects back."
},
"pvforecast5_module_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Module Model",
"description": "Model of the PV modules of this plane."
},
"pvforecast5_inverter_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Inverter Model",
"description": "Model of the inverter of this plane."
},
"pvforecast5_inverter_paco": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Inverter Paco",
"description": "AC power rating of the inverter. [W]"
},
"pvforecast5_modules_per_string": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Modules Per String",
"description": "Number of the PV modules of the strings of this plane."
},
"pvforecast5_strings_per_inverter": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pvforecast5 Strings Per Inverter",
"description": "Number of the strings of the inverter of this plane."
},
"load_import_file_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Load Import File Path",
"description": "Path to the file to import load data from."
},
"load_import_json": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Load Import Json",
"description": "JSON string, dictionary of load forecast value lists."
},
"loadakkudoktor_year_energy": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Loadakkudoktor Year Energy",
"description": "Yearly energy consumption (kWh)."
},
"load_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Load Provider",
"description": "Load provider id of provider to be used."
},
"elecpriceimport_file_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Elecpriceimport File Path",
"description": "Path to the file to import elecprice data from."
},
"elecpriceimport_json": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Elecpriceimport Json",
"description": "JSON string, dictionary of electricity price forecast value lists."
},
"elecprice_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Elecprice Provider",
"description": "Electricity price provider id of provider to be used."
},
"elecprice_charges_kwh": {
"anyOf": [
{
"type": "number",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Elecprice Charges Kwh",
"description": "Electricity price charges (\u20ac/kWh)."
},
"prediction_hours": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Prediction Hours",
"description": "Number of hours into the future for predictions",
"default": 48
},
"prediction_historic_hours": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Prediction Historic Hours",
"description": "Number of hours into the past for historical predictions data",
"default": 48
},
"latitude": {
"anyOf": [
{
"type": "number",
"maximum": 90.0,
"minimum": -90.0
},
{
"type": "null"
}
],
"title": "Latitude",
"description": "Latitude in decimal degrees, between -90 and 90, north is positive (ISO 19115) (\u00b0)"
},
"longitude": {
"anyOf": [
{
"type": "number",
"maximum": 180.0,
"minimum": -180.0
},
{
"type": "null"
}
],
"title": "Longitude",
"description": "Longitude in decimal degrees, within -180 to 180 (\u00b0)"
},
"optimization_hours": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Optimization Hours",
"description": "Number of hours into the future for optimizations.",
"default": 24
},
"optimization_penalty": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Optimization Penalty",
"description": "Penalty factor used in optimization.",
"default": 10
},
"optimization_ev_available_charge_rates_percent": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Optimization Ev Available Charge Rates Percent",
"description": "Charge rates available for the EV in percent of maximum charge.",
"default": [
0.0,
0.375,
0.5,
0.625,
0.75,
0.875,
1.0
]
},
"measurement_load0_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Measurement Load0 Name",
"description": "Name of the load0 source (e.g. 'Household', 'Heat Pump')"
},
"measurement_load1_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Measurement Load1 Name",
"description": "Name of the load1 source (e.g. 'Household', 'Heat Pump')"
},
"measurement_load2_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Measurement Load2 Name",
"description": "Name of the load2 source (e.g. 'Household', 'Heat Pump')"
},
"measurement_load3_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Measurement Load3 Name",
"description": "Name of the load3 source (e.g. 'Household', 'Heat Pump')"
},
"measurement_load4_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Measurement Load4 Name",
"description": "Name of the load4 source (e.g. 'Household', 'Heat Pump')"
},
"battery_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Battery Provider",
"description": "Id of Battery simulation provider."
},
"battery_capacity": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Battery Capacity",
"description": "Battery capacity [Wh]."
},
"battery_initial_soc": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Battery Initial Soc",
"description": "Battery initial state of charge [%]."
},
"battery_soc_min": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Battery Soc Min",
"description": "Battery minimum state of charge [%]."
},
"battery_soc_max": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Battery Soc Max",
"description": "Battery maximum state of charge [%]."
},
"battery_charging_efficiency": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Battery Charging Efficiency",
"description": "Battery charging efficiency [%]."
},
"battery_discharging_efficiency": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Battery Discharging Efficiency",
"description": "Battery discharging efficiency [%]."
},
"battery_max_charging_power": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Battery Max Charging Power",
"description": "Battery maximum charge power [W]."
},
"bev_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Bev Provider",
"description": "Id of Battery Electric Vehicle simulation provider."
},
"bev_capacity": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Bev Capacity",
"description": "Battery Electric Vehicle capacity [Wh]."
},
"bev_initial_soc": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Bev Initial Soc",
"description": "Battery Electric Vehicle initial state of charge [%]."
},
"bev_soc_max": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Bev Soc Max",
"description": "Battery Electric Vehicle maximum state of charge [%]."
},
"bev_charging_efficiency": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Bev Charging Efficiency",
"description": "Battery Electric Vehicle charging efficiency [%]."
},
"bev_discharging_efficiency": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Bev Discharging Efficiency",
"description": "Battery Electric Vehicle discharging efficiency [%]."
},
"bev_max_charging_power": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Bev Max Charging Power",
"description": "Battery Electric Vehicle maximum charge power [W]."
},
"dishwasher_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dishwasher Provider",
"description": "Id of Dish Washer simulation provider."
},
"dishwasher_consumption": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Dishwasher Consumption",
"description": "Dish Washer energy consumption [Wh]."
},
"dishwasher_duration": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Dishwasher Duration",
"description": "Dish Washer usage duration [h]."
},
"inverter_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Inverter Provider",
"description": "Id of PV Inverter simulation provider."
},
"inverter_power_max": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Inverter Power Max",
"description": "Inverter maximum power [W]."
},
"logging_level_default": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Logging Level Default",
"description": "EOS default logging level."
},
"data_folder_path": {
"anyOf": [
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Data Folder Path",
"description": "Path to EOS data directory."
},
"data_output_subpath": {
"anyOf": [
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Data Output Subpath",
"description": "Sub-path for the EOS output data directory.",
"default": "output"
},
"data_cache_subpath": {
"anyOf": [
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Data Cache Subpath",
"description": "Sub-path for the EOS cache data directory.",
"default": "cache"
},
"pvforecast_planes": {
"items": {
"type": "string"
},
"type": "array",
"title": "Pvforecast Planes",
"description": "Compute a list of active planes.",
"readOnly": true
},
"pvforecast_planes_peakpower": {
"items": {
"type": "number"
},
"type": "array",
"title": "Pvforecast Planes Peakpower",
"description": "Compute a list of the peak power per active planes.",
"readOnly": true
},
"pvforecast_planes_azimuth": {
"items": {
"type": "number"
},
"type": "array",
"title": "Pvforecast Planes Azimuth",
"description": "Compute a list of the azimuths per active planes.",
"readOnly": true
},
"pvforecast_planes_tilt": {
"items": {
"type": "number"
},
"type": "array",
"title": "Pvforecast Planes Tilt",
"description": "Compute a list of the tilts per active planes.",
"readOnly": true
},
"pvforecast_planes_userhorizon": {
"title": "Pvforecast Planes Userhorizon",
"description": "Compute a list of the user horizon per active planes.",
"readOnly": true
},
"pvforecast_planes_inverter_paco": {
"title": "Pvforecast Planes Inverter Paco",
"description": "Compute a list of the maximum power rating of the inverter per active planes.",
"readOnly": true
},
"timezone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Timezone",
"description": "Compute timezone based on latitude and longitude.",
"readOnly": true
},
"logging_level_root": {
"type": "string",
"title": "Logging Level Root",
"description": "Root logger logging level.",
"readOnly": true
},
"data_output_path": {
"anyOf": [
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Data Output Path",
"description": "Compute data_output_path based on data_folder_path.",
"readOnly": true
},
"data_cache_path": {
"anyOf": [
{
"type": "string",
"format": "path"
},
{
"type": "null"
}
],
"title": "Data Cache Path",
"description": "Compute data_cache_path based on data_folder_path.",
"readOnly": true
}
},
"type": "object",
"required": [
"pvforecast_planes",
"pvforecast_planes_peakpower",
"pvforecast_planes_azimuth",
"pvforecast_planes_tilt",
"pvforecast_planes_userhorizon",
"pvforecast_planes_inverter_paco",
"timezone",
"logging_level_root",
"data_output_path",
"data_cache_path"
],
"title": "SettingsEOS",
"description": "Settings for all EOS."
},
"SimulationResult": {
"properties": {
"Last_Wh_pro_Stunde": {
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Last Wh Pro Stunde",
"description": "TBD"
},
"EAuto_SoC_pro_Stunde": {
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Eauto Soc Pro Stunde",
"description": "The state of charge of the EV for each hour."
},
"Einnahmen_Euro_pro_Stunde": {
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Einnahmen Euro Pro Stunde",
"description": "The revenue from grid feed-in or other sources in euros per hour."
},
"Gesamt_Verluste": {
"type": "number",
"title": "Gesamt Verluste",
"description": "The total losses in watt-hours over the entire period."
},
"Gesamtbilanz_Euro": {
"type": "number",
"title": "Gesamtbilanz Euro",
"description": "The total balance of revenues minus costs in euros."
},
"Gesamteinnahmen_Euro": {
"type": "number",
"title": "Gesamteinnahmen Euro",
"description": "The total revenues in euros."
},
"Gesamtkosten_Euro": {
"type": "number",
"title": "Gesamtkosten Euro",
"description": "The total costs in euros."
},
"Home_appliance_wh_per_hour": {
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Home Appliance Wh Per Hour",
"description": "The energy consumption of a household appliance in watt-hours per hour."
},
"Kosten_Euro_pro_Stunde": {
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Kosten Euro Pro Stunde",
"description": "The costs in euros per hour."
},
"Netzbezug_Wh_pro_Stunde": {
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Netzbezug Wh Pro Stunde",
"description": "The grid energy drawn in watt-hours per hour."
},
"Netzeinspeisung_Wh_pro_Stunde": {
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Netzeinspeisung Wh Pro Stunde",
"description": "The energy fed into the grid in watt-hours per hour."
},
"Verluste_Pro_Stunde": {
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Verluste Pro Stunde",
"description": "The losses in watt-hours per hour."
},
"akku_soc_pro_stunde": {
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Akku Soc Pro Stunde",
"description": "The state of charge of the battery (not the EV) in percentage per hour."
},
"Electricity_price": {
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Electricity Price",
"description": "Used Electricity Price, including predictions"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"Last_Wh_pro_Stunde",
"EAuto_SoC_pro_Stunde",
"Einnahmen_Euro_pro_Stunde",
"Gesamt_Verluste",
"Gesamtbilanz_Euro",
"Gesamteinnahmen_Euro",
"Gesamtkosten_Euro",
"Home_appliance_wh_per_hour",
"Kosten_Euro_pro_Stunde",
"Netzbezug_Wh_pro_Stunde",
"Netzeinspeisung_Wh_pro_Stunde",
"Verluste_Pro_Stunde",
"akku_soc_pro_stunde",
"Electricity_price"
],
"title": "SimulationResult",
"description": "This object contains the results of the simulation and provides insights into various parameters over the entire forecast period."
},
"SolarPanelBatteryParameters": {
"properties": {
"capacity_wh": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Capacity Wh",
"description": "An integer representing the capacity of the battery in watt-hours."
},
"charging_efficiency": {
"type": "number",
"maximum": 1.0,
"exclusiveMinimum": 0.0,
"title": "Charging Efficiency",
"description": "A float representing the charging efficiency of the battery.",
"default": 0.88
},
"discharging_efficiency": {
"type": "number",
"maximum": 1.0,
"exclusiveMinimum": 0.0,
"title": "Discharging Efficiency",
"description": "A float representing the discharge efficiency of the battery.",
"default": 0.88
},
"max_charge_power_w": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Max Charge Power W",
"description": "Maximum charging power in watts.",
"default": 5000
},
"initial_soc_percentage": {
"type": "integer",
"maximum": 100.0,
"minimum": 0.0,
"title": "Initial Soc Percentage",
"description": "An integer representing the state of charge of the battery at the **start** of the current hour (not the current state).",
"default": 0
},
"min_soc_percentage": {
"type": "integer",
"maximum": 100.0,
"minimum": 0.0,
"title": "Min Soc Percentage",
"description": "An integer representing the minimum state of charge (SOC) of the battery in percentage.",
"default": 0
},
"max_soc_percentage": {
"type": "integer",
"maximum": 100.0,
"minimum": 0.0,
"title": "Max Soc Percentage",
"description": "An integer representing the maximum state of charge (SOC) of the battery in percentage.",
"default": 100
}
},
"additionalProperties": false,
"type": "object",
"required": [
"capacity_wh"
],
"title": "SolarPanelBatteryParameters"
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
}
}
}
}
Reference in New Issue View Git Blame Copy Permalink