2025-01-03 00:31:20 +01:00
{
2025-03-02 11:19:54 +01:00
"components" : {
"schemas" : {
"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 ```" ,
"properties" : {
"battery_capacity" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery capacity [Wh]." ,
"title" : "Battery Capacity"
} ,
"battery_charging_efficiency" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery charging efficiency [%]." ,
"title" : "Battery Charging Efficiency"
} ,
"battery_discharging_efficiency" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery discharging efficiency [%]." ,
"title" : "Battery Discharging Efficiency"
} ,
"battery_initial_soc" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery initial state of charge [%]." ,
"title" : "Battery Initial Soc"
} ,
"battery_max_charging_power" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery maximum charge power [W]." ,
"title" : "Battery Max Charging Power"
} ,
"battery_provider" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Id of Battery simulation provider." ,
"title" : "Battery Provider"
} ,
"battery_soc_max" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery maximum state of charge [%]." ,
"title" : "Battery Soc Max"
} ,
"battery_soc_min" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery minimum state of charge [%]." ,
"title" : "Battery Soc Min"
} ,
"bev_capacity" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery Electric Vehicle capacity [Wh]." ,
"title" : "Bev Capacity"
} ,
"bev_charging_efficiency" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery Electric Vehicle charging efficiency [%]." ,
"title" : "Bev Charging Efficiency"
} ,
"bev_discharging_efficiency" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery Electric Vehicle discharging efficiency [%]." ,
"title" : "Bev Discharging Efficiency"
} ,
"bev_initial_soc" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery Electric Vehicle initial state of charge [%]." ,
"title" : "Bev Initial Soc"
} ,
"bev_max_charging_power" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery Electric Vehicle maximum charge power [W]." ,
"title" : "Bev Max Charging Power"
} ,
"bev_provider" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Id of Battery Electric Vehicle simulation provider." ,
"title" : "Bev Provider"
} ,
"bev_soc_max" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery Electric Vehicle maximum state of charge [%]." ,
"title" : "Bev Soc Max"
} ,
"config_default_file_path" : {
"description" : "Compute the default config file path." ,
"format" : "path" ,
"readOnly" : true ,
"title" : "Config Default File Path" ,
"type" : "string"
} ,
"config_file_path" : {
"anyOf" : [
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Path to EOS configuration file." ,
"readOnly" : true ,
"title" : "Config File Path"
} ,
"config_folder_path" : {
"anyOf" : [
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Path to EOS configuration directory." ,
"readOnly" : true ,
"title" : "Config Folder Path"
} ,
"config_keys" : {
"description" : "Returns the keys of all fields in the configuration." ,
"items" : {
"type" : "string"
} ,
"readOnly" : true ,
"title" : "Config Keys" ,
"type" : "array"
} ,
"config_keys_read_only" : {
"description" : "Returns the keys of all read only fields in the configuration." ,
"items" : {
"type" : "string"
} ,
"readOnly" : true ,
"title" : "Config Keys Read Only" ,
"type" : "array"
} ,
"data_cache_path" : {
"anyOf" : [
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Compute data_cache_path based on data_folder_path." ,
"readOnly" : true ,
"title" : "Data Cache Path"
} ,
"data_cache_subpath" : {
"anyOf" : [
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "cache" ,
"description" : "Sub-path for the EOS cache data directory." ,
"title" : "Data Cache Subpath"
} ,
"data_folder_path" : {
"anyOf" : [
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Path to EOS data directory." ,
"title" : "Data Folder Path"
} ,
"data_output_path" : {
"anyOf" : [
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Compute data_output_path based on data_folder_path." ,
"readOnly" : true ,
"title" : "Data Output Path"
} ,
"data_output_subpath" : {
"anyOf" : [
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "output" ,
"description" : "Sub-path for the EOS output data directory." ,
"title" : "Data Output Subpath"
} ,
"dishwasher_consumption" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Dish Washer energy consumption [Wh]." ,
"title" : "Dishwasher Consumption"
} ,
"dishwasher_duration" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Dish Washer usage duration [h]." ,
"title" : "Dishwasher Duration"
} ,
"dishwasher_provider" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Id of Dish Washer simulation provider." ,
"title" : "Dishwasher Provider"
} ,
"elecprice_charges_kwh" : {
"anyOf" : [
{
"minimum" : 0.0 ,
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Electricity price charges (\u20ac/kWh)." ,
"title" : "Elecprice Charges Kwh"
} ,
"elecprice_provider" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Electricity price provider id of provider to be used." ,
"title" : "Elecprice Provider"
} ,
"elecpriceimport_file_path" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Path to the file to import elecprice data from." ,
"title" : "Elecpriceimport File Path"
} ,
"elecpriceimport_json" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "JSON string, dictionary of electricity price forecast value lists." ,
"title" : "Elecpriceimport Json"
} ,
"inverter_power_max" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Inverter maximum power [W]." ,
"title" : "Inverter Power Max"
} ,
"inverter_provider" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Id of PV Inverter simulation provider." ,
"title" : "Inverter Provider"
} ,
"latitude" : {
"anyOf" : [
{
"maximum" : 90.0 ,
"minimum" : -90.0 ,
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Latitude in decimal degrees, between -90 and 90, north is positive (ISO 19115) (\u00b0)" ,
"title" : "Latitude"
} ,
"load_import_file_path" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Path to the file to import load data from." ,
"title" : "Load Import File Path"
} ,
"load_import_json" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "JSON string, dictionary of load forecast value lists." ,
"title" : "Load Import Json"
} ,
"load_provider" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Load provider id of provider to be used." ,
"title" : "Load Provider"
} ,
"loadakkudoktor_year_energy" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Yearly energy consumption (kWh)." ,
"title" : "Loadakkudoktor Year Energy"
} ,
"logging_level_default" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "EOS default logging level." ,
"title" : "Logging Level Default"
} ,
"logging_level_root" : {
"description" : "Root logger logging level." ,
"readOnly" : true ,
"title" : "Logging Level Root" ,
"type" : "string"
} ,
"longitude" : {
"anyOf" : [
{
"maximum" : 180.0 ,
"minimum" : -180.0 ,
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Longitude in decimal degrees, within -180 to 180 (\u00b0)" ,
"title" : "Longitude"
} ,
"measurement_load0_name" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Name of the load0 source (e.g. 'Household', 'Heat Pump')" ,
"title" : "Measurement Load0 Name"
} ,
"measurement_load1_name" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Name of the load1 source (e.g. 'Household', 'Heat Pump')" ,
"title" : "Measurement Load1 Name"
} ,
"measurement_load2_name" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Name of the load2 source (e.g. 'Household', 'Heat Pump')" ,
"title" : "Measurement Load2 Name"
} ,
"measurement_load3_name" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Name of the load3 source (e.g. 'Household', 'Heat Pump')" ,
"title" : "Measurement Load3 Name"
} ,
"measurement_load4_name" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Name of the load4 source (e.g. 'Household', 'Heat Pump')" ,
"title" : "Measurement Load4 Name"
} ,
"optimization_ev_available_charge_rates_percent" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"default" : [
0.0 ,
0.375 ,
0.5 ,
0.625 ,
0.75 ,
0.875 ,
1.0
] ,
"description" : "Charge rates available for the EV in percent of maximum charge." ,
"title" : "Optimization Ev Available Charge Rates Percent"
} ,
"optimization_hours" : {
"anyOf" : [
{
"minimum" : 0.0 ,
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"default" : 24 ,
"description" : "Number of hours into the future for optimizations." ,
"title" : "Optimization Hours"
} ,
"optimization_penalty" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"default" : 10 ,
"description" : "Penalty factor used in optimization." ,
"title" : "Optimization Penalty"
} ,
"package_root_path" : {
"description" : "Compute the package root path." ,
"format" : "path" ,
"readOnly" : true ,
"title" : "Package Root Path" ,
"type" : "string"
} ,
"prediction_historic_hours" : {
"anyOf" : [
{
"minimum" : 0.0 ,
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"default" : 48 ,
"description" : "Number of hours into the past for historical predictions data" ,
"title" : "Prediction Historic Hours"
} ,
"prediction_hours" : {
"anyOf" : [
{
"minimum" : 0.0 ,
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"default" : 48 ,
"description" : "Number of hours into the future for predictions" ,
"title" : "Prediction Hours"
} ,
"pvforecast0_albedo" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"title" : "Pvforecast0 Albedo"
} ,
"pvforecast0_inverter_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the inverter of this plane." ,
"title" : "Pvforecast0 Inverter Model"
} ,
"pvforecast0_inverter_paco" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "AC power rating of the inverter. [W]" ,
"title" : "Pvforecast0 Inverter Paco"
} ,
"pvforecast0_loss" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 14.0 ,
"description" : "Sum of PV system losses in percent" ,
"title" : "Pvforecast0 Loss"
} ,
"pvforecast0_module_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the PV modules of this plane." ,
"title" : "Pvforecast0 Module Model"
} ,
"pvforecast0_modules_per_string" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the PV modules of the strings of this plane." ,
"title" : "Pvforecast0 Modules Per String"
} ,
"pvforecast0_mountingplace" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "free" ,
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"title" : "Pvforecast0 Mountingplace"
} ,
"pvforecast0_optimal_surface_tilt" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"title" : "Pvforecast0 Optimal Surface Tilt"
} ,
"pvforecast0_optimalangles" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"title" : "Pvforecast0 Optimalangles"
} ,
"pvforecast0_peakpower" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Nominal power of PV system in kW." ,
"title" : "Pvforecast0 Peakpower"
} ,
"pvforecast0_pvtechchoice" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "crystSi" ,
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"title" : "Pvforecast0 Pvtechchoice"
} ,
"pvforecast0_strings_per_inverter" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the strings of the inverter of this plane." ,
"title" : "Pvforecast0 Strings Per Inverter"
} ,
"pvforecast0_surface_azimuth" : {
"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"
} ,
"pvforecast0_surface_tilt" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"title" : "Pvforecast0 Surface Tilt"
} ,
"pvforecast0_trackingtype" : {
"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"
} ,
"pvforecast0_userhorizon" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"title" : "Pvforecast0 Userhorizon"
} ,
"pvforecast1_albedo" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"title" : "Pvforecast1 Albedo"
} ,
"pvforecast1_inverter_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the inverter of this plane." ,
"title" : "Pvforecast1 Inverter Model"
} ,
"pvforecast1_inverter_paco" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "AC power rating of the inverter. [W]" ,
"title" : "Pvforecast1 Inverter Paco"
} ,
"pvforecast1_loss" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 14.0 ,
"description" : "Sum of PV system losses in percent" ,
"title" : "Pvforecast1 Loss"
} ,
"pvforecast1_module_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the PV modules of this plane." ,
"title" : "Pvforecast1 Module Model"
} ,
"pvforecast1_modules_per_string" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the PV modules of the strings of this plane." ,
"title" : "Pvforecast1 Modules Per String"
} ,
"pvforecast1_mountingplace" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "free" ,
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"title" : "Pvforecast1 Mountingplace"
} ,
"pvforecast1_optimal_surface_tilt" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"title" : "Pvforecast1 Optimal Surface Tilt"
} ,
"pvforecast1_optimalangles" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"title" : "Pvforecast1 Optimalangles"
} ,
"pvforecast1_peakpower" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Nominal power of PV system in kW." ,
"title" : "Pvforecast1 Peakpower"
} ,
"pvforecast1_pvtechchoice" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "crystSi" ,
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"title" : "Pvforecast1 Pvtechchoice"
} ,
"pvforecast1_strings_per_inverter" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the strings of the inverter of this plane." ,
"title" : "Pvforecast1 Strings Per Inverter"
} ,
"pvforecast1_surface_azimuth" : {
"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"
} ,
"pvforecast1_surface_tilt" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"title" : "Pvforecast1 Surface Tilt"
} ,
"pvforecast1_trackingtype" : {
"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"
} ,
"pvforecast1_userhorizon" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"title" : "Pvforecast1 Userhorizon"
} ,
"pvforecast2_albedo" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"title" : "Pvforecast2 Albedo"
} ,
"pvforecast2_inverter_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the inverter of this plane." ,
"title" : "Pvforecast2 Inverter Model"
} ,
"pvforecast2_inverter_paco" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "AC power rating of the inverter. [W]" ,
"title" : "Pvforecast2 Inverter Paco"
} ,
"pvforecast2_loss" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 14.0 ,
"description" : "Sum of PV system losses in percent" ,
"title" : "Pvforecast2 Loss"
} ,
"pvforecast2_module_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the PV modules of this plane." ,
"title" : "Pvforecast2 Module Model"
} ,
"pvforecast2_modules_per_string" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the PV modules of the strings of this plane." ,
"title" : "Pvforecast2 Modules Per String"
} ,
"pvforecast2_mountingplace" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "free" ,
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"title" : "Pvforecast2 Mountingplace"
} ,
"pvforecast2_optimal_surface_tilt" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"title" : "Pvforecast2 Optimal Surface Tilt"
} ,
"pvforecast2_optimalangles" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"title" : "Pvforecast2 Optimalangles"
} ,
"pvforecast2_peakpower" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Nominal power of PV system in kW." ,
"title" : "Pvforecast2 Peakpower"
} ,
"pvforecast2_pvtechchoice" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "crystSi" ,
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"title" : "Pvforecast2 Pvtechchoice"
} ,
"pvforecast2_strings_per_inverter" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the strings of the inverter of this plane." ,
"title" : "Pvforecast2 Strings Per Inverter"
} ,
"pvforecast2_surface_azimuth" : {
"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"
} ,
"pvforecast2_surface_tilt" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"title" : "Pvforecast2 Surface Tilt"
} ,
"pvforecast2_trackingtype" : {
"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"
} ,
"pvforecast2_userhorizon" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"title" : "Pvforecast2 Userhorizon"
} ,
"pvforecast3_albedo" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"title" : "Pvforecast3 Albedo"
} ,
"pvforecast3_inverter_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the inverter of this plane." ,
"title" : "Pvforecast3 Inverter Model"
} ,
"pvforecast3_inverter_paco" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "AC power rating of the inverter. [W]" ,
"title" : "Pvforecast3 Inverter Paco"
} ,
"pvforecast3_loss" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 14.0 ,
"description" : "Sum of PV system losses in percent" ,
"title" : "Pvforecast3 Loss"
} ,
"pvforecast3_module_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the PV modules of this plane." ,
"title" : "Pvforecast3 Module Model"
} ,
"pvforecast3_modules_per_string" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the PV modules of the strings of this plane." ,
"title" : "Pvforecast3 Modules Per String"
} ,
"pvforecast3_mountingplace" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "free" ,
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"title" : "Pvforecast3 Mountingplace"
} ,
"pvforecast3_optimal_surface_tilt" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"title" : "Pvforecast3 Optimal Surface Tilt"
} ,
"pvforecast3_optimalangles" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"title" : "Pvforecast3 Optimalangles"
} ,
"pvforecast3_peakpower" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Nominal power of PV system in kW." ,
"title" : "Pvforecast3 Peakpower"
} ,
"pvforecast3_pvtechchoice" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "crystSi" ,
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"title" : "Pvforecast3 Pvtechchoice"
} ,
"pvforecast3_strings_per_inverter" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the strings of the inverter of this plane." ,
"title" : "Pvforecast3 Strings Per Inverter"
} ,
"pvforecast3_surface_azimuth" : {
"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"
} ,
"pvforecast3_surface_tilt" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"title" : "Pvforecast3 Surface Tilt"
} ,
"pvforecast3_trackingtype" : {
"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"
} ,
"pvforecast3_userhorizon" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"title" : "Pvforecast3 Userhorizon"
} ,
"pvforecast4_albedo" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"title" : "Pvforecast4 Albedo"
} ,
"pvforecast4_inverter_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the inverter of this plane." ,
"title" : "Pvforecast4 Inverter Model"
} ,
"pvforecast4_inverter_paco" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "AC power rating of the inverter. [W]" ,
"title" : "Pvforecast4 Inverter Paco"
} ,
"pvforecast4_loss" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 14.0 ,
"description" : "Sum of PV system losses in percent" ,
"title" : "Pvforecast4 Loss"
} ,
"pvforecast4_module_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the PV modules of this plane." ,
"title" : "Pvforecast4 Module Model"
} ,
"pvforecast4_modules_per_string" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the PV modules of the strings of this plane." ,
"title" : "Pvforecast4 Modules Per String"
} ,
"pvforecast4_mountingplace" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "free" ,
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"title" : "Pvforecast4 Mountingplace"
} ,
"pvforecast4_optimal_surface_tilt" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"title" : "Pvforecast4 Optimal Surface Tilt"
} ,
"pvforecast4_optimalangles" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"title" : "Pvforecast4 Optimalangles"
} ,
"pvforecast4_peakpower" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Nominal power of PV system in kW." ,
"title" : "Pvforecast4 Peakpower"
} ,
"pvforecast4_pvtechchoice" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "crystSi" ,
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"title" : "Pvforecast4 Pvtechchoice"
} ,
"pvforecast4_strings_per_inverter" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the strings of the inverter of this plane." ,
"title" : "Pvforecast4 Strings Per Inverter"
} ,
"pvforecast4_surface_azimuth" : {
"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"
} ,
"pvforecast4_surface_tilt" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"title" : "Pvforecast4 Surface Tilt"
} ,
"pvforecast4_trackingtype" : {
"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"
} ,
"pvforecast4_userhorizon" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"title" : "Pvforecast4 Userhorizon"
} ,
"pvforecast5_albedo" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"title" : "Pvforecast5 Albedo"
} ,
"pvforecast5_inverter_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the inverter of this plane." ,
"title" : "Pvforecast5 Inverter Model"
} ,
"pvforecast5_inverter_paco" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "AC power rating of the inverter. [W]" ,
"title" : "Pvforecast5 Inverter Paco"
} ,
"pvforecast5_loss" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 14.0 ,
"description" : "Sum of PV system losses in percent" ,
"title" : "Pvforecast5 Loss"
} ,
"pvforecast5_module_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the PV modules of this plane." ,
"title" : "Pvforecast5 Module Model"
} ,
"pvforecast5_modules_per_string" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the PV modules of the strings of this plane." ,
"title" : "Pvforecast5 Modules Per String"
} ,
"pvforecast5_mountingplace" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "free" ,
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"title" : "Pvforecast5 Mountingplace"
} ,
"pvforecast5_optimal_surface_tilt" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"title" : "Pvforecast5 Optimal Surface Tilt"
} ,
"pvforecast5_optimalangles" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"title" : "Pvforecast5 Optimalangles"
} ,
"pvforecast5_peakpower" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Nominal power of PV system in kW." ,
"title" : "Pvforecast5 Peakpower"
} ,
"pvforecast5_pvtechchoice" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "crystSi" ,
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"title" : "Pvforecast5 Pvtechchoice"
} ,
"pvforecast5_strings_per_inverter" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the strings of the inverter of this plane." ,
"title" : "Pvforecast5 Strings Per Inverter"
} ,
"pvforecast5_surface_azimuth" : {
"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"
} ,
"pvforecast5_surface_tilt" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"title" : "Pvforecast5 Surface Tilt"
} ,
"pvforecast5_trackingtype" : {
"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"
} ,
"pvforecast5_userhorizon" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"title" : "Pvforecast5 Userhorizon"
} ,
"pvforecast_planes" : {
"description" : "Compute a list of active planes." ,
"items" : {
"type" : "string"
} ,
"readOnly" : true ,
"title" : "Pvforecast Planes" ,
"type" : "array"
} ,
"pvforecast_planes_azimuth" : {
"description" : "Compute a list of the azimuths per active planes." ,
"items" : {
"type" : "number"
} ,
"readOnly" : true ,
"title" : "Pvforecast Planes Azimuth" ,
"type" : "array"
} ,
"pvforecast_planes_inverter_paco" : {
"description" : "Compute a list of the maximum power rating of the inverter per active planes." ,
"readOnly" : true ,
"title" : "Pvforecast Planes Inverter Paco"
} ,
"pvforecast_planes_peakpower" : {
"description" : "Compute a list of the peak power per active planes." ,
"items" : {
"type" : "number"
} ,
"readOnly" : true ,
"title" : "Pvforecast Planes Peakpower" ,
"type" : "array"
} ,
"pvforecast_planes_tilt" : {
"description" : "Compute a list of the tilts per active planes." ,
"items" : {
"type" : "number"
} ,
"readOnly" : true ,
"title" : "Pvforecast Planes Tilt" ,
"type" : "array"
} ,
"pvforecast_planes_userhorizon" : {
"description" : "Compute a list of the user horizon per active planes." ,
"readOnly" : true ,
"title" : "Pvforecast Planes Userhorizon"
} ,
"pvforecast_provider" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "PVForecast provider id of provider to be used." ,
"title" : "Pvforecast Provider"
} ,
"pvforecastimport_file_path" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Path to the file to import PV forecast data from." ,
"title" : "Pvforecastimport File Path"
} ,
"pvforecastimport_json" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "JSON string, dictionary of PV forecast value lists." ,
"title" : "Pvforecastimport Json"
} ,
"server_eos_host" : {
"anyOf" : [
{
"format" : "ipvanyaddress" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "127.0.0.1" ,
"description" : "EOS server IP address." ,
"title" : "Server Eos Host"
} ,
"server_eos_port" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"default" : 8503 ,
"description" : "EOS server IP port number." ,
"title" : "Server Eos Port"
} ,
"server_eos_startup_eosdash" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : true ,
"description" : "EOS server to start EOSdash server." ,
"title" : "Server Eos Startup Eosdash"
} ,
"server_eos_verbose" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Enable debug output" ,
"title" : "Server Eos Verbose"
} ,
"server_eosdash_host" : {
"anyOf" : [
{
"format" : "ipvanyaddress" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "127.0.0.1" ,
"description" : "EOSdash server IP address." ,
"title" : "Server Eosdash Host"
} ,
"server_eosdash_port" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"default" : 8504 ,
"description" : "EOSdash server IP port number." ,
"title" : "Server Eosdash Port"
} ,
"timezone" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Compute timezone based on latitude and longitude." ,
"readOnly" : true ,
"title" : "Timezone"
} ,
"weather_provider" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Weather provider id of provider to be used." ,
"title" : "Weather Provider"
} ,
"weatherimport_file_path" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Path to the file to import weather data from." ,
"title" : "Weatherimport File Path"
} ,
"weatherimport_json" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "JSON string, dictionary of weather forecast value lists." ,
"title" : "Weatherimport Json"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"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" ,
"type" : "object"
} ,
"ElectricVehicleParameters" : {
"additionalProperties" : false ,
"description" : "Parameters specific to an electric vehicle (EV)." ,
"properties" : {
"capacity_wh" : {
"description" : "An integer representing the capacity of the battery in watt-hours." ,
"exclusiveMinimum" : 0.0 ,
"title" : "Capacity Wh" ,
"type" : "integer"
} ,
"charging_efficiency" : {
"default" : 0.88 ,
"description" : "A float representing the charging efficiency of the battery." ,
"exclusiveMinimum" : 0.0 ,
"maximum" : 1.0 ,
"title" : "Charging Efficiency" ,
"type" : "number"
} ,
"discharging_efficiency" : {
"default" : 1.0 ,
"title" : "Discharging Efficiency" ,
"type" : "number"
} ,
"initial_soc_percentage" : {
"default" : 0 ,
"description" : "An integer representing the current state of charge (SOC) of the battery in percentage." ,
"maximum" : 100.0 ,
"minimum" : 0.0 ,
"title" : "Initial Soc Percentage" ,
"type" : "integer"
} ,
"max_charge_power_w" : {
"anyOf" : [
{
"exclusiveMinimum" : 0.0 ,
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 5000 ,
"description" : "Maximum charging power in watts." ,
"title" : "Max Charge Power W"
} ,
"max_soc_percentage" : {
"default" : 100 ,
"description" : "An integer representing the maximum state of charge (SOC) of the battery in percentage." ,
"maximum" : 100.0 ,
"minimum" : 0.0 ,
"title" : "Max Soc Percentage" ,
"type" : "integer"
} ,
"min_soc_percentage" : {
"default" : 0 ,
"description" : "An integer representing the minimum state of charge (SOC) of the battery in percentage." ,
"maximum" : 100.0 ,
"minimum" : 0.0 ,
"title" : "Min Soc Percentage" ,
"type" : "integer"
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"required" : [
"capacity_wh"
] ,
"title" : "ElectricVehicleParameters" ,
"type" : "object"
} ,
"ElectricVehicleResult" : {
"description" : "Result class containing information related to the electric vehicle's charging and discharging behavior." ,
"properties" : {
"capacity_wh" : {
"description" : "Capacity of the EV\u2019s battery in watt-hours." ,
"title" : "Capacity Wh" ,
"type" : "integer"
} ,
"charge_array" : {
"description" : "Hourly charging status (0 for no charging, 1 for charging)." ,
"items" : {
"type" : "number"
} ,
"title" : "Charge Array" ,
"type" : "array"
} ,
"charging_efficiency" : {
"description" : "Charging efficiency as a float.." ,
"title" : "Charging Efficiency" ,
"type" : "number"
} ,
"discharge_array" : {
"description" : "Hourly discharging status (0 for no discharging, 1 for discharging)." ,
"items" : {
"type" : "integer"
} ,
"title" : "Discharge Array" ,
"type" : "array"
} ,
"discharging_efficiency" : {
"description" : "The discharge efficiency as a float.." ,
"title" : "Discharging Efficiency" ,
"type" : "number"
} ,
"hours" : {
"description" : "Number of hours in the simulation." ,
"title" : "Hours" ,
"type" : "integer"
} ,
"initial_soc_percentage" : {
"description" : "State of charge at the start of the simulation in percentage." ,
"title" : "Initial Soc Percentage" ,
"type" : "integer"
} ,
"max_charge_power_w" : {
"description" : "Maximum charging power in watts." ,
"title" : "Max Charge Power W" ,
"type" : "integer"
} ,
"soc_wh" : {
"description" : "State of charge of the battery in watt-hours at the start of the simulation." ,
"title" : "Soc Wh" ,
"type" : "number"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"required" : [
"charge_array" ,
"discharge_array" ,
"discharging_efficiency" ,
"hours" ,
"capacity_wh" ,
"charging_efficiency" ,
"max_charge_power_w" ,
"soc_wh" ,
"initial_soc_percentage"
] ,
"title" : "ElectricVehicleResult" ,
"type" : "object"
} ,
"EnergieManagementSystemParameters" : {
"additionalProperties" : false ,
"properties" : {
"einspeiseverguetung_euro_pro_wh" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "number"
}
] ,
"description" : "A float or array of floats representing the feed-in compensation in euros per watt-hour." ,
"title" : "Einspeiseverguetung Euro Pro Wh"
} ,
"gesamtlast" : {
"description" : "An array of floats representing the total load (consumption) in watts for different time intervals." ,
"items" : {
"type" : "number"
} ,
"title" : "Gesamtlast" ,
"type" : "array"
} ,
"preis_euro_pro_wh_akku" : {
"description" : "A float representing the cost of battery energy per watt-hour." ,
"title" : "Preis Euro Pro Wh Akku" ,
"type" : "number"
} ,
"pv_prognose_wh" : {
"description" : "An array of floats representing the forecasted photovoltaic output in watts for different time intervals." ,
"items" : {
"type" : "number"
} ,
"title" : "Pv Prognose Wh" ,
"type" : "array"
} ,
"strompreis_euro_pro_wh" : {
"description" : "An array of floats representing the electricity price in euros per watt-hour for different time intervals." ,
"items" : {
"type" : "number"
} ,
"title" : "Strompreis Euro Pro Wh" ,
"type" : "array"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"required" : [
"pv_prognose_wh" ,
"strompreis_euro_pro_wh" ,
"einspeiseverguetung_euro_pro_wh" ,
"preis_euro_pro_wh_akku" ,
"gesamtlast"
] ,
"title" : "EnergieManagementSystemParameters" ,
"type" : "object"
} ,
"ForecastResponse" : {
"properties" : {
"pvpower" : {
"items" : {
"type" : "number"
} ,
"title" : "Pvpower" ,
"type" : "array"
} ,
"temperature" : {
"items" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
]
} ,
"title" : "Temperature" ,
"type" : "array"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"required" : [
"temperature" ,
"pvpower"
] ,
"title" : "ForecastResponse" ,
"type" : "object"
} ,
"GesamtlastRequest" : {
"properties" : {
"hours" : {
"title" : "Hours" ,
"type" : "integer"
} ,
"measured_data" : {
"items" : {
"type" : "object"
} ,
"title" : "Measured Data" ,
"type" : "array"
} ,
"year_energy" : {
"title" : "Year Energy" ,
"type" : "number"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"required" : [
"year_energy" ,
"measured_data" ,
"hours"
] ,
"title" : "GesamtlastRequest" ,
"type" : "object"
} ,
"HTTPValidationError" : {
"properties" : {
"detail" : {
"items" : {
"$ref" : "#/components/schemas/ValidationError"
} ,
"title" : "Detail" ,
"type" : "array"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"title" : "HTTPValidationError" ,
"type" : "object"
} ,
"HomeApplianceParameters" : {
"additionalProperties" : false ,
"properties" : {
"consumption_wh" : {
"description" : "An integer representing the energy consumption of a household device in watt-hours." ,
"exclusiveMinimum" : 0.0 ,
"title" : "Consumption Wh" ,
"type" : "integer"
} ,
"duration_h" : {
"description" : "An integer representing the usage duration of a household device in hours." ,
"exclusiveMinimum" : 0.0 ,
"title" : "Duration H" ,
"type" : "integer"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"required" : [
"consumption_wh" ,
"duration_h"
] ,
"title" : "HomeApplianceParameters" ,
"type" : "object"
} ,
"InverterParameters" : {
"additionalProperties" : false ,
"properties" : {
"max_power_wh" : {
"exclusiveMinimum" : 0.0 ,
"title" : "Max Power Wh" ,
"type" : "number"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"required" : [
"max_power_wh"
] ,
"title" : "InverterParameters" ,
"type" : "object"
} ,
"OptimizationParameters" : {
"additionalProperties" : false ,
"properties" : {
"dishwasher" : {
"anyOf" : [
{
"$ref" : "#/components/schemas/HomeApplianceParameters"
} ,
{
"type" : "null"
}
]
} ,
"eauto" : {
"anyOf" : [
{
"$ref" : "#/components/schemas/ElectricVehicleParameters"
} ,
{
"type" : "null"
}
]
} ,
"ems" : {
"$ref" : "#/components/schemas/EnergieManagementSystemParameters"
} ,
"inverter" : {
"anyOf" : [
{
"$ref" : "#/components/schemas/InverterParameters"
} ,
{
"type" : "null"
}
]
} ,
"pv_akku" : {
"anyOf" : [
{
"$ref" : "#/components/schemas/SolarPanelBatteryParameters"
} ,
{
"type" : "null"
}
]
} ,
"start_solution" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "Can be `null` or contain a previous solution (if available)." ,
"title" : "Start Solution"
} ,
"temperature_forecast" : {
"anyOf" : [
{
"items" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
]
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "An array of floats representing the temperature forecast in degrees Celsius for different time intervals." ,
"title" : "Temperature Forecast"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"required" : [
"ems" ,
"pv_akku" ,
"inverter" ,
"eauto"
] ,
"title" : "OptimizationParameters" ,
"type" : "object"
} ,
"OptimizeResponse" : {
"additionalProperties" : false ,
"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." ,
"properties" : {
"ac_charge" : {
"description" : "Array with AC charging values as relative power (0-1), other values set to 0." ,
"items" : {
"type" : "number"
} ,
"title" : "Ac Charge" ,
"type" : "array"
} ,
"dc_charge" : {
"description" : "Array with DC charging values as relative power (0-1), other values set to 0." ,
"items" : {
"type" : "number"
} ,
"title" : "Dc Charge" ,
"type" : "array"
} ,
"discharge_allowed" : {
"description" : "Array with discharge values (1 for discharge, 0 otherwise)." ,
"items" : {
"type" : "integer"
} ,
"title" : "Discharge Allowed" ,
"type" : "array"
} ,
"eauto_obj" : {
"anyOf" : [
{
"$ref" : "#/components/schemas/ElectricVehicleResult"
} ,
{
"type" : "null"
}
]
} ,
"eautocharge_hours_float" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "TBD" ,
"title" : "Eautocharge Hours Float"
} ,
"result" : {
"$ref" : "#/components/schemas/SimulationResult"
} ,
"start_solution" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "An array of binary values (0 or 1) representing a possible starting solution for the simulation." ,
"title" : "Start Solution"
} ,
"washingstart" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Can be `null` or contain an object representing the start of washing (if applicable)." ,
"title" : "Washingstart"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"required" : [
"ac_charge" ,
"dc_charge" ,
"discharge_allowed" ,
"eautocharge_hours_float" ,
"result" ,
"eauto_obj"
] ,
"title" : "OptimizeResponse" ,
"type" : "object"
} ,
"PydanticDateTimeData" : {
"additionalProperties" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"items" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "integer"
} ,
{
"type" : "string"
} ,
{
"type" : "null"
}
]
} ,
"type" : "array"
}
]
} ,
"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 }" ,
"title" : "PydanticDateTimeData" ,
"type" : "object"
} ,
"PydanticDateTimeDataFrame" : {
"description" : "Pydantic model for validating pandas DataFrame data with datetime index." ,
"properties" : {
"data" : {
"additionalProperties" : {
"type" : "object"
} ,
"title" : "Data" ,
"type" : "object"
} ,
"datetime_columns" : {
"description" : "Columns to be treated as datetime" ,
"items" : {
"type" : "string"
} ,
"title" : "Datetime Columns" ,
"type" : "array"
} ,
"dtypes" : {
"additionalProperties" : {
"type" : "string"
} ,
"title" : "Dtypes" ,
"type" : "object"
} ,
"tz" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Timezone for datetime values" ,
"title" : "Tz"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"required" : [
"data"
] ,
"title" : "PydanticDateTimeDataFrame" ,
"type" : "object"
} ,
"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." ,
"properties" : {
"data" : {
"title" : "Data" ,
"type" : "object"
} ,
"dtype" : {
"default" : "float64" ,
"title" : "Dtype" ,
"type" : "string"
} ,
"tz" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"title" : "Tz"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"required" : [
"data"
] ,
"title" : "PydanticDateTimeSeries" ,
"type" : "object"
} ,
"SettingsEOS" : {
"description" : "Settings for all EOS." ,
"properties" : {
"battery_capacity" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery capacity [Wh]." ,
"title" : "Battery Capacity"
} ,
"battery_charging_efficiency" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery charging efficiency [%]." ,
"title" : "Battery Charging Efficiency"
} ,
"battery_discharging_efficiency" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery discharging efficiency [%]." ,
"title" : "Battery Discharging Efficiency"
} ,
"battery_initial_soc" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery initial state of charge [%]." ,
"title" : "Battery Initial Soc"
} ,
"battery_max_charging_power" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery maximum charge power [W]." ,
"title" : "Battery Max Charging Power"
} ,
"battery_provider" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Id of Battery simulation provider." ,
"title" : "Battery Provider"
} ,
"battery_soc_max" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery maximum state of charge [%]." ,
"title" : "Battery Soc Max"
} ,
"battery_soc_min" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery minimum state of charge [%]." ,
"title" : "Battery Soc Min"
} ,
"bev_capacity" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery Electric Vehicle capacity [Wh]." ,
"title" : "Bev Capacity"
} ,
"bev_charging_efficiency" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery Electric Vehicle charging efficiency [%]." ,
"title" : "Bev Charging Efficiency"
} ,
"bev_discharging_efficiency" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery Electric Vehicle discharging efficiency [%]." ,
"title" : "Bev Discharging Efficiency"
} ,
"bev_initial_soc" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery Electric Vehicle initial state of charge [%]." ,
"title" : "Bev Initial Soc"
} ,
"bev_max_charging_power" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery Electric Vehicle maximum charge power [W]." ,
"title" : "Bev Max Charging Power"
} ,
"bev_provider" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Id of Battery Electric Vehicle simulation provider." ,
"title" : "Bev Provider"
} ,
"bev_soc_max" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery Electric Vehicle maximum state of charge [%]." ,
"title" : "Bev Soc Max"
} ,
"data_cache_path" : {
"anyOf" : [
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Compute data_cache_path based on data_folder_path." ,
"readOnly" : true ,
"title" : "Data Cache Path"
} ,
"data_cache_subpath" : {
"anyOf" : [
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "cache" ,
"description" : "Sub-path for the EOS cache data directory." ,
"title" : "Data Cache Subpath"
} ,
"data_folder_path" : {
"anyOf" : [
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Path to EOS data directory." ,
"title" : "Data Folder Path"
} ,
"data_output_path" : {
"anyOf" : [
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Compute data_output_path based on data_folder_path." ,
"readOnly" : true ,
"title" : "Data Output Path"
} ,
"data_output_subpath" : {
"anyOf" : [
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "output" ,
"description" : "Sub-path for the EOS output data directory." ,
"title" : "Data Output Subpath"
} ,
"dishwasher_consumption" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Dish Washer energy consumption [Wh]." ,
"title" : "Dishwasher Consumption"
} ,
"dishwasher_duration" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Dish Washer usage duration [h]." ,
"title" : "Dishwasher Duration"
} ,
"dishwasher_provider" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Id of Dish Washer simulation provider." ,
"title" : "Dishwasher Provider"
} ,
"elecprice_charges_kwh" : {
"anyOf" : [
{
"minimum" : 0.0 ,
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Electricity price charges (\u20ac/kWh)." ,
"title" : "Elecprice Charges Kwh"
} ,
"elecprice_provider" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Electricity price provider id of provider to be used." ,
"title" : "Elecprice Provider"
} ,
"elecpriceimport_file_path" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Path to the file to import elecprice data from." ,
"title" : "Elecpriceimport File Path"
} ,
"elecpriceimport_json" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "JSON string, dictionary of electricity price forecast value lists." ,
"title" : "Elecpriceimport Json"
} ,
"inverter_power_max" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Inverter maximum power [W]." ,
"title" : "Inverter Power Max"
} ,
"inverter_provider" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Id of PV Inverter simulation provider." ,
"title" : "Inverter Provider"
} ,
"latitude" : {
"anyOf" : [
{
"maximum" : 90.0 ,
"minimum" : -90.0 ,
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Latitude in decimal degrees, between -90 and 90, north is positive (ISO 19115) (\u00b0)" ,
"title" : "Latitude"
} ,
"load_import_file_path" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Path to the file to import load data from." ,
"title" : "Load Import File Path"
} ,
"load_import_json" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "JSON string, dictionary of load forecast value lists." ,
"title" : "Load Import Json"
} ,
"load_provider" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Load provider id of provider to be used." ,
"title" : "Load Provider"
} ,
"loadakkudoktor_year_energy" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Yearly energy consumption (kWh)." ,
"title" : "Loadakkudoktor Year Energy"
} ,
"logging_level_default" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "EOS default logging level." ,
"title" : "Logging Level Default"
} ,
"logging_level_root" : {
"description" : "Root logger logging level." ,
"readOnly" : true ,
"title" : "Logging Level Root" ,
"type" : "string"
} ,
"longitude" : {
"anyOf" : [
{
"maximum" : 180.0 ,
"minimum" : -180.0 ,
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Longitude in decimal degrees, within -180 to 180 (\u00b0)" ,
"title" : "Longitude"
} ,
"measurement_load0_name" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Name of the load0 source (e.g. 'Household', 'Heat Pump')" ,
"title" : "Measurement Load0 Name"
} ,
"measurement_load1_name" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Name of the load1 source (e.g. 'Household', 'Heat Pump')" ,
"title" : "Measurement Load1 Name"
} ,
"measurement_load2_name" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Name of the load2 source (e.g. 'Household', 'Heat Pump')" ,
"title" : "Measurement Load2 Name"
} ,
"measurement_load3_name" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Name of the load3 source (e.g. 'Household', 'Heat Pump')" ,
"title" : "Measurement Load3 Name"
} ,
"measurement_load4_name" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Name of the load4 source (e.g. 'Household', 'Heat Pump')" ,
"title" : "Measurement Load4 Name"
} ,
"optimization_ev_available_charge_rates_percent" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"default" : [
0.0 ,
0.375 ,
0.5 ,
0.625 ,
0.75 ,
0.875 ,
1.0
] ,
"description" : "Charge rates available for the EV in percent of maximum charge." ,
"title" : "Optimization Ev Available Charge Rates Percent"
} ,
"optimization_hours" : {
"anyOf" : [
{
"minimum" : 0.0 ,
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"default" : 24 ,
"description" : "Number of hours into the future for optimizations." ,
"title" : "Optimization Hours"
} ,
"optimization_penalty" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"default" : 10 ,
"description" : "Penalty factor used in optimization." ,
"title" : "Optimization Penalty"
} ,
"prediction_historic_hours" : {
"anyOf" : [
{
"minimum" : 0.0 ,
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"default" : 48 ,
"description" : "Number of hours into the past for historical predictions data" ,
"title" : "Prediction Historic Hours"
} ,
"prediction_hours" : {
"anyOf" : [
{
"minimum" : 0.0 ,
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"default" : 48 ,
"description" : "Number of hours into the future for predictions" ,
"title" : "Prediction Hours"
} ,
"pvforecast0_albedo" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"title" : "Pvforecast0 Albedo"
} ,
"pvforecast0_inverter_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the inverter of this plane." ,
"title" : "Pvforecast0 Inverter Model"
} ,
"pvforecast0_inverter_paco" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "AC power rating of the inverter. [W]" ,
"title" : "Pvforecast0 Inverter Paco"
} ,
"pvforecast0_loss" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 14.0 ,
"description" : "Sum of PV system losses in percent" ,
"title" : "Pvforecast0 Loss"
} ,
"pvforecast0_module_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the PV modules of this plane." ,
"title" : "Pvforecast0 Module Model"
} ,
"pvforecast0_modules_per_string" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the PV modules of the strings of this plane." ,
"title" : "Pvforecast0 Modules Per String"
} ,
"pvforecast0_mountingplace" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "free" ,
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"title" : "Pvforecast0 Mountingplace"
} ,
"pvforecast0_optimal_surface_tilt" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"title" : "Pvforecast0 Optimal Surface Tilt"
} ,
"pvforecast0_optimalangles" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"title" : "Pvforecast0 Optimalangles"
} ,
"pvforecast0_peakpower" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Nominal power of PV system in kW." ,
"title" : "Pvforecast0 Peakpower"
} ,
"pvforecast0_pvtechchoice" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "crystSi" ,
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"title" : "Pvforecast0 Pvtechchoice"
} ,
"pvforecast0_strings_per_inverter" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the strings of the inverter of this plane." ,
"title" : "Pvforecast0 Strings Per Inverter"
} ,
"pvforecast0_surface_azimuth" : {
"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"
} ,
"pvforecast0_surface_tilt" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"title" : "Pvforecast0 Surface Tilt"
} ,
"pvforecast0_trackingtype" : {
"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"
} ,
"pvforecast0_userhorizon" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"title" : "Pvforecast0 Userhorizon"
} ,
"pvforecast1_albedo" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"title" : "Pvforecast1 Albedo"
} ,
"pvforecast1_inverter_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the inverter of this plane." ,
"title" : "Pvforecast1 Inverter Model"
} ,
"pvforecast1_inverter_paco" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "AC power rating of the inverter. [W]" ,
"title" : "Pvforecast1 Inverter Paco"
} ,
"pvforecast1_loss" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 14.0 ,
"description" : "Sum of PV system losses in percent" ,
"title" : "Pvforecast1 Loss"
} ,
"pvforecast1_module_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the PV modules of this plane." ,
"title" : "Pvforecast1 Module Model"
} ,
"pvforecast1_modules_per_string" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the PV modules of the strings of this plane." ,
"title" : "Pvforecast1 Modules Per String"
} ,
"pvforecast1_mountingplace" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "free" ,
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"title" : "Pvforecast1 Mountingplace"
} ,
"pvforecast1_optimal_surface_tilt" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"title" : "Pvforecast1 Optimal Surface Tilt"
} ,
"pvforecast1_optimalangles" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"title" : "Pvforecast1 Optimalangles"
} ,
"pvforecast1_peakpower" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Nominal power of PV system in kW." ,
"title" : "Pvforecast1 Peakpower"
} ,
"pvforecast1_pvtechchoice" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "crystSi" ,
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"title" : "Pvforecast1 Pvtechchoice"
} ,
"pvforecast1_strings_per_inverter" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the strings of the inverter of this plane." ,
"title" : "Pvforecast1 Strings Per Inverter"
} ,
"pvforecast1_surface_azimuth" : {
"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"
} ,
"pvforecast1_surface_tilt" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"title" : "Pvforecast1 Surface Tilt"
} ,
"pvforecast1_trackingtype" : {
"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"
} ,
"pvforecast1_userhorizon" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"title" : "Pvforecast1 Userhorizon"
} ,
"pvforecast2_albedo" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"title" : "Pvforecast2 Albedo"
} ,
"pvforecast2_inverter_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the inverter of this plane." ,
"title" : "Pvforecast2 Inverter Model"
} ,
"pvforecast2_inverter_paco" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "AC power rating of the inverter. [W]" ,
"title" : "Pvforecast2 Inverter Paco"
} ,
"pvforecast2_loss" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 14.0 ,
"description" : "Sum of PV system losses in percent" ,
"title" : "Pvforecast2 Loss"
} ,
"pvforecast2_module_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the PV modules of this plane." ,
"title" : "Pvforecast2 Module Model"
} ,
"pvforecast2_modules_per_string" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the PV modules of the strings of this plane." ,
"title" : "Pvforecast2 Modules Per String"
} ,
"pvforecast2_mountingplace" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "free" ,
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"title" : "Pvforecast2 Mountingplace"
} ,
"pvforecast2_optimal_surface_tilt" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"title" : "Pvforecast2 Optimal Surface Tilt"
} ,
"pvforecast2_optimalangles" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"title" : "Pvforecast2 Optimalangles"
} ,
"pvforecast2_peakpower" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Nominal power of PV system in kW." ,
"title" : "Pvforecast2 Peakpower"
} ,
"pvforecast2_pvtechchoice" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "crystSi" ,
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"title" : "Pvforecast2 Pvtechchoice"
} ,
"pvforecast2_strings_per_inverter" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the strings of the inverter of this plane." ,
"title" : "Pvforecast2 Strings Per Inverter"
} ,
"pvforecast2_surface_azimuth" : {
"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"
} ,
"pvforecast2_surface_tilt" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"title" : "Pvforecast2 Surface Tilt"
} ,
"pvforecast2_trackingtype" : {
"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"
} ,
"pvforecast2_userhorizon" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"title" : "Pvforecast2 Userhorizon"
} ,
"pvforecast3_albedo" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"title" : "Pvforecast3 Albedo"
} ,
"pvforecast3_inverter_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the inverter of this plane." ,
"title" : "Pvforecast3 Inverter Model"
} ,
"pvforecast3_inverter_paco" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "AC power rating of the inverter. [W]" ,
"title" : "Pvforecast3 Inverter Paco"
} ,
"pvforecast3_loss" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 14.0 ,
"description" : "Sum of PV system losses in percent" ,
"title" : "Pvforecast3 Loss"
} ,
"pvforecast3_module_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the PV modules of this plane." ,
"title" : "Pvforecast3 Module Model"
} ,
"pvforecast3_modules_per_string" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the PV modules of the strings of this plane." ,
"title" : "Pvforecast3 Modules Per String"
} ,
"pvforecast3_mountingplace" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "free" ,
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"title" : "Pvforecast3 Mountingplace"
} ,
"pvforecast3_optimal_surface_tilt" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"title" : "Pvforecast3 Optimal Surface Tilt"
} ,
"pvforecast3_optimalangles" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"title" : "Pvforecast3 Optimalangles"
} ,
"pvforecast3_peakpower" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Nominal power of PV system in kW." ,
"title" : "Pvforecast3 Peakpower"
} ,
"pvforecast3_pvtechchoice" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "crystSi" ,
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"title" : "Pvforecast3 Pvtechchoice"
} ,
"pvforecast3_strings_per_inverter" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the strings of the inverter of this plane." ,
"title" : "Pvforecast3 Strings Per Inverter"
} ,
"pvforecast3_surface_azimuth" : {
"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"
} ,
"pvforecast3_surface_tilt" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"title" : "Pvforecast3 Surface Tilt"
} ,
"pvforecast3_trackingtype" : {
"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"
} ,
"pvforecast3_userhorizon" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"title" : "Pvforecast3 Userhorizon"
} ,
"pvforecast4_albedo" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"title" : "Pvforecast4 Albedo"
} ,
"pvforecast4_inverter_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the inverter of this plane." ,
"title" : "Pvforecast4 Inverter Model"
} ,
"pvforecast4_inverter_paco" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "AC power rating of the inverter. [W]" ,
"title" : "Pvforecast4 Inverter Paco"
} ,
"pvforecast4_loss" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 14.0 ,
"description" : "Sum of PV system losses in percent" ,
"title" : "Pvforecast4 Loss"
} ,
"pvforecast4_module_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the PV modules of this plane." ,
"title" : "Pvforecast4 Module Model"
} ,
"pvforecast4_modules_per_string" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the PV modules of the strings of this plane." ,
"title" : "Pvforecast4 Modules Per String"
} ,
"pvforecast4_mountingplace" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "free" ,
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"title" : "Pvforecast4 Mountingplace"
} ,
"pvforecast4_optimal_surface_tilt" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"title" : "Pvforecast4 Optimal Surface Tilt"
} ,
"pvforecast4_optimalangles" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"title" : "Pvforecast4 Optimalangles"
} ,
"pvforecast4_peakpower" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Nominal power of PV system in kW." ,
"title" : "Pvforecast4 Peakpower"
} ,
"pvforecast4_pvtechchoice" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "crystSi" ,
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"title" : "Pvforecast4 Pvtechchoice"
} ,
"pvforecast4_strings_per_inverter" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the strings of the inverter of this plane." ,
"title" : "Pvforecast4 Strings Per Inverter"
} ,
"pvforecast4_surface_azimuth" : {
"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"
} ,
"pvforecast4_surface_tilt" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"title" : "Pvforecast4 Surface Tilt"
} ,
"pvforecast4_trackingtype" : {
"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"
} ,
"pvforecast4_userhorizon" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"title" : "Pvforecast4 Userhorizon"
} ,
"pvforecast5_albedo" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"title" : "Pvforecast5 Albedo"
} ,
"pvforecast5_inverter_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the inverter of this plane." ,
"title" : "Pvforecast5 Inverter Model"
} ,
"pvforecast5_inverter_paco" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "AC power rating of the inverter. [W]" ,
"title" : "Pvforecast5 Inverter Paco"
} ,
"pvforecast5_loss" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 14.0 ,
"description" : "Sum of PV system losses in percent" ,
"title" : "Pvforecast5 Loss"
} ,
"pvforecast5_module_model" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the PV modules of this plane." ,
"title" : "Pvforecast5 Module Model"
} ,
"pvforecast5_modules_per_string" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the PV modules of the strings of this plane." ,
"title" : "Pvforecast5 Modules Per String"
} ,
"pvforecast5_mountingplace" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "free" ,
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"title" : "Pvforecast5 Mountingplace"
} ,
"pvforecast5_optimal_surface_tilt" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"title" : "Pvforecast5 Optimal Surface Tilt"
} ,
"pvforecast5_optimalangles" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"title" : "Pvforecast5 Optimalangles"
} ,
"pvforecast5_peakpower" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Nominal power of PV system in kW." ,
"title" : "Pvforecast5 Peakpower"
} ,
"pvforecast5_pvtechchoice" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "crystSi" ,
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"title" : "Pvforecast5 Pvtechchoice"
} ,
"pvforecast5_strings_per_inverter" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Number of the strings of the inverter of this plane." ,
"title" : "Pvforecast5 Strings Per Inverter"
} ,
"pvforecast5_surface_azimuth" : {
"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"
} ,
"pvforecast5_surface_tilt" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"title" : "Pvforecast5 Surface Tilt"
} ,
"pvforecast5_trackingtype" : {
"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"
} ,
"pvforecast5_userhorizon" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"title" : "Pvforecast5 Userhorizon"
} ,
"pvforecast_planes" : {
"description" : "Compute a list of active planes." ,
"items" : {
"type" : "string"
} ,
"readOnly" : true ,
"title" : "Pvforecast Planes" ,
"type" : "array"
} ,
"pvforecast_planes_azimuth" : {
"description" : "Compute a list of the azimuths per active planes." ,
"items" : {
"type" : "number"
} ,
"readOnly" : true ,
"title" : "Pvforecast Planes Azimuth" ,
"type" : "array"
} ,
"pvforecast_planes_inverter_paco" : {
"description" : "Compute a list of the maximum power rating of the inverter per active planes." ,
"readOnly" : true ,
"title" : "Pvforecast Planes Inverter Paco"
} ,
"pvforecast_planes_peakpower" : {
"description" : "Compute a list of the peak power per active planes." ,
"items" : {
"type" : "number"
} ,
"readOnly" : true ,
"title" : "Pvforecast Planes Peakpower" ,
"type" : "array"
} ,
"pvforecast_planes_tilt" : {
"description" : "Compute a list of the tilts per active planes." ,
"items" : {
"type" : "number"
} ,
"readOnly" : true ,
"title" : "Pvforecast Planes Tilt" ,
"type" : "array"
} ,
"pvforecast_planes_userhorizon" : {
"description" : "Compute a list of the user horizon per active planes." ,
"readOnly" : true ,
"title" : "Pvforecast Planes Userhorizon"
} ,
"pvforecast_provider" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "PVForecast provider id of provider to be used." ,
"title" : "Pvforecast Provider"
} ,
"pvforecastimport_file_path" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Path to the file to import PV forecast data from." ,
"title" : "Pvforecastimport File Path"
} ,
"pvforecastimport_json" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "JSON string, dictionary of PV forecast value lists." ,
"title" : "Pvforecastimport Json"
} ,
"server_eos_host" : {
"anyOf" : [
{
"format" : "ipvanyaddress" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "127.0.0.1" ,
"description" : "EOS server IP address." ,
"title" : "Server Eos Host"
} ,
"server_eos_port" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"default" : 8503 ,
"description" : "EOS server IP port number." ,
"title" : "Server Eos Port"
} ,
"server_eos_startup_eosdash" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : true ,
"description" : "EOS server to start EOSdash server." ,
"title" : "Server Eos Startup Eosdash"
} ,
"server_eos_verbose" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Enable debug output" ,
"title" : "Server Eos Verbose"
} ,
"server_eosdash_host" : {
"anyOf" : [
{
"format" : "ipvanyaddress" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "127.0.0.1" ,
"description" : "EOSdash server IP address." ,
"title" : "Server Eosdash Host"
} ,
"server_eosdash_port" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"default" : 8504 ,
"description" : "EOSdash server IP port number." ,
"title" : "Server Eosdash Port"
} ,
"timezone" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Compute timezone based on latitude and longitude." ,
"readOnly" : true ,
"title" : "Timezone"
} ,
"weather_provider" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Weather provider id of provider to be used." ,
"title" : "Weather Provider"
} ,
"weatherimport_file_path" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Path to the file to import weather data from." ,
"title" : "Weatherimport File Path"
} ,
"weatherimport_json" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "JSON string, dictionary of weather forecast value lists." ,
"title" : "Weatherimport Json"
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"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" ,
"type" : "object"
} ,
"SimulationResult" : {
"additionalProperties" : false ,
"description" : "This object contains the results of the simulation and provides insights into various parameters over the entire forecast period." ,
"properties" : {
"EAuto_SoC_pro_Stunde" : {
"description" : "The state of charge of the EV for each hour." ,
"items" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
]
} ,
"title" : "Eauto Soc Pro Stunde" ,
"type" : "array"
} ,
"Einnahmen_Euro_pro_Stunde" : {
"description" : "The revenue from grid feed-in or other sources in euros per hour." ,
"items" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
]
} ,
"title" : "Einnahmen Euro Pro Stunde" ,
"type" : "array"
} ,
"Electricity_price" : {
"description" : "Used Electricity Price, including predictions" ,
"items" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
]
} ,
"title" : "Electricity Price" ,
"type" : "array"
} ,
"Gesamt_Verluste" : {
"description" : "The total losses in watt-hours over the entire period." ,
"title" : "Gesamt Verluste" ,
"type" : "number"
} ,
"Gesamtbilanz_Euro" : {
"description" : "The total balance of revenues minus costs in euros." ,
"title" : "Gesamtbilanz Euro" ,
"type" : "number"
} ,
"Gesamteinnahmen_Euro" : {
"description" : "The total revenues in euros." ,
"title" : "Gesamteinnahmen Euro" ,
"type" : "number"
} ,
"Gesamtkosten_Euro" : {
"description" : "The total costs in euros." ,
"title" : "Gesamtkosten Euro" ,
"type" : "number"
} ,
"Home_appliance_wh_per_hour" : {
"description" : "The energy consumption of a household appliance in watt-hours per hour." ,
"items" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
]
} ,
"title" : "Home Appliance Wh Per Hour" ,
"type" : "array"
} ,
"Kosten_Euro_pro_Stunde" : {
"description" : "The costs in euros per hour." ,
"items" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
]
} ,
"title" : "Kosten Euro Pro Stunde" ,
"type" : "array"
} ,
"Last_Wh_pro_Stunde" : {
"description" : "TBD" ,
"items" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
]
} ,
"title" : "Last Wh Pro Stunde" ,
"type" : "array"
} ,
"Netzbezug_Wh_pro_Stunde" : {
"description" : "The grid energy drawn in watt-hours per hour." ,
"items" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
]
} ,
"title" : "Netzbezug Wh Pro Stunde" ,
"type" : "array"
} ,
"Netzeinspeisung_Wh_pro_Stunde" : {
"description" : "The energy fed into the grid in watt-hours per hour." ,
"items" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
]
} ,
"title" : "Netzeinspeisung Wh Pro Stunde" ,
"type" : "array"
} ,
"Verluste_Pro_Stunde" : {
"description" : "The losses in watt-hours per hour." ,
"items" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
]
} ,
"title" : "Verluste Pro Stunde" ,
"type" : "array"
} ,
"akku_soc_pro_stunde" : {
"description" : "The state of charge of the battery (not the EV) in percentage per hour." ,
"items" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
]
} ,
"title" : "Akku Soc Pro Stunde" ,
"type" : "array"
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"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" ,
"type" : "object"
} ,
"SolarPanelBatteryParameters" : {
"additionalProperties" : false ,
"properties" : {
"capacity_wh" : {
"description" : "An integer representing the capacity of the battery in watt-hours." ,
"exclusiveMinimum" : 0.0 ,
"title" : "Capacity Wh" ,
"type" : "integer"
} ,
"charging_efficiency" : {
"default" : 0.88 ,
"description" : "A float representing the charging efficiency of the battery." ,
"exclusiveMinimum" : 0.0 ,
"maximum" : 1.0 ,
"title" : "Charging Efficiency" ,
"type" : "number"
} ,
"discharging_efficiency" : {
"default" : 0.88 ,
"description" : "A float representing the discharge efficiency of the battery." ,
"exclusiveMinimum" : 0.0 ,
"maximum" : 1.0 ,
"title" : "Discharging Efficiency" ,
"type" : "number"
} ,
"initial_soc_percentage" : {
"default" : 0 ,
"description" : "An integer representing the state of charge of the battery at the **start** of the current hour (not the current state)." ,
"maximum" : 100.0 ,
"minimum" : 0.0 ,
"title" : "Initial Soc Percentage" ,
"type" : "integer"
} ,
"max_charge_power_w" : {
"anyOf" : [
{
"exclusiveMinimum" : 0.0 ,
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 5000 ,
"description" : "Maximum charging power in watts." ,
"title" : "Max Charge Power W"
} ,
"max_soc_percentage" : {
"default" : 100 ,
"description" : "An integer representing the maximum state of charge (SOC) of the battery in percentage." ,
"maximum" : 100.0 ,
"minimum" : 0.0 ,
"title" : "Max Soc Percentage" ,
"type" : "integer"
} ,
"min_soc_percentage" : {
"default" : 0 ,
"description" : "An integer representing the minimum state of charge (SOC) of the battery in percentage." ,
"maximum" : 100.0 ,
"minimum" : 0.0 ,
"title" : "Min Soc Percentage" ,
"type" : "integer"
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"required" : [
"capacity_wh"
] ,
"title" : "SolarPanelBatteryParameters" ,
"type" : "object"
} ,
"ValidationError" : {
"properties" : {
"loc" : {
"items" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "integer"
}
]
} ,
"title" : "Location" ,
"type" : "array"
} ,
"msg" : {
"title" : "Message" ,
"type" : "string"
} ,
"type" : {
"title" : "Error Type" ,
"type" : "string"
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"required" : [
"loc" ,
"msg" ,
"type"
] ,
"title" : "ValidationError" ,
"type" : "object"
}
}
} ,
"info" : {
"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." ,
"title" : "Akkudoktor-EOS" ,
"version" : "0.0.1"
} ,
"openapi" : "3.1.0" ,
"paths" : {
"/gesamtlast" : {
"post" : {
"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" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"type" : "number"
} ,
"title" : "Response Fastapi Gesamtlast Gesamtlast Post" ,
"type" : "array"
}
}
} ,
"description" : "Successful Response"
} ,
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HTTPValidationError"
}
}
} ,
"description" : "Validation Error"
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Gesamtlast"
}
} ,
"/gesamtlast_simple" : {
"get" : {
"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" : [
{
"in" : "query" ,
"name" : "year_energy" ,
"required" : true ,
"schema" : {
"title" : "Year Energy" ,
"type" : "number"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"type" : "number"
} ,
"title" : "Response Fastapi Gesamtlast Simple Gesamtlast Simple Get" ,
"type" : "array"
}
}
} ,
"description" : "Successful Response"
} ,
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HTTPValidationError"
}
}
} ,
"description" : "Validation Error"
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Gesamtlast Simple"
}
} ,
"/optimize" : {
"post" : {
"operationId" : "fastapi_optimize_optimize_post" ,
"parameters" : [
{
"description" : "Defaults to current hour of the day." ,
"in" : "query" ,
"name" : "start_hour" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Defaults to current hour of the day." ,
"title" : "Start Hour"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/OptimizationParameters"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/OptimizeResponse"
}
}
} ,
"description" : "Successful Response"
} ,
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HTTPValidationError"
}
}
} ,
"description" : "Validation Error"
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Optimize"
}
} ,
"/pvforecast" : {
"get" : {
"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" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ForecastResponse"
}
}
} ,
"description" : "Successful Response"
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Pvforecast"
}
} ,
"/strompreis" : {
"get" : {
"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" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"type" : "number"
} ,
"title" : "Response Fastapi Strompreis Strompreis Get" ,
"type" : "array"
}
}
} ,
"description" : "Successful Response"
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Strompreis"
}
} ,
"/v1/config" : {
"get" : {
"description" : "Get the current configuration.\n\nReturns:\n configuration (ConfigEOS): The current configuration." ,
"operationId" : "fastapi_config_get_v1_config_get" ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigEOS"
}
}
} ,
"description" : "Successful Response"
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Config Get"
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"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" : [
{
"description" : "EOS server IP address." ,
"in" : "query" ,
"name" : "server_eos_host" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"format" : "ipvanyaddress" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "127.0.0.1" ,
"description" : "EOS server IP address." ,
"title" : "Server Eos Host"
}
} ,
{
"description" : "EOS server IP port number." ,
"in" : "query" ,
"name" : "server_eos_port" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"default" : 8503 ,
"description" : "EOS server IP port number." ,
"title" : "Server Eos Port"
}
} ,
{
"description" : "Enable debug output" ,
"in" : "query" ,
"name" : "server_eos_verbose" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Enable debug output" ,
"title" : "Server Eos Verbose"
}
} ,
{
"description" : "EOS server to start EOSdash server." ,
"in" : "query" ,
"name" : "server_eos_startup_eosdash" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : true ,
"description" : "EOS server to start EOSdash server." ,
"title" : "Server Eos Startup Eosdash"
}
} ,
{
"description" : "EOSdash server IP address." ,
"in" : "query" ,
"name" : "server_eosdash_host" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"format" : "ipvanyaddress" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "127.0.0.1" ,
"description" : "EOSdash server IP address." ,
"title" : "Server Eosdash Host"
}
} ,
{
"description" : "EOSdash server IP port number." ,
"in" : "query" ,
"name" : "server_eosdash_port" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"default" : 8504 ,
"description" : "EOSdash server IP port number." ,
"title" : "Server Eosdash Port"
}
} ,
{
"description" : "Path to the file to import weather data from." ,
"in" : "query" ,
"name" : "weatherimport_file_path" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Path to the file to import weather data from." ,
"title" : "Weatherimport File Path"
}
} ,
{
"description" : "JSON string, dictionary of weather forecast value lists." ,
"in" : "query" ,
"name" : "weatherimport_json" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "JSON string, dictionary of weather forecast value lists." ,
"title" : "Weatherimport Json"
}
} ,
{
"description" : "Weather provider id of provider to be used." ,
"in" : "query" ,
"name" : "weather_provider" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Weather provider id of provider to be used." ,
"title" : "Weather Provider"
}
} ,
{
"description" : "Path to the file to import PV forecast data from." ,
"in" : "query" ,
"name" : "pvforecastimport_file_path" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Path to the file to import PV forecast data from." ,
"title" : "Pvforecastimport File Path"
}
} ,
{
"description" : "JSON string, dictionary of PV forecast value lists." ,
"in" : "query" ,
"name" : "pvforecastimport_json" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "JSON string, dictionary of PV forecast value lists." ,
"title" : "Pvforecastimport Json"
}
} ,
{
"description" : "PVForecast provider id of provider to be used." ,
"in" : "query" ,
"name" : "pvforecast_provider" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "PVForecast provider id of provider to be used." ,
"title" : "Pvforecast Provider"
}
} ,
{
"description" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"in" : "query" ,
"name" : "pvforecast0_surface_tilt" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"title" : "Pvforecast0 Surface Tilt"
}
} ,
{
"description" : "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)." ,
"in" : "query" ,
"name" : "pvforecast0_surface_azimuth" ,
"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" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"in" : "query" ,
"name" : "pvforecast0_userhorizon" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"title" : "Pvforecast0 Userhorizon"
}
} ,
{
"description" : "Nominal power of PV system in kW." ,
"in" : "query" ,
"name" : "pvforecast0_peakpower" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Nominal power of PV system in kW." ,
"title" : "Pvforecast0 Peakpower"
}
} ,
{
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"in" : "query" ,
"name" : "pvforecast0_pvtechchoice" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "crystSi" ,
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"title" : "Pvforecast0 Pvtechchoice"
}
} ,
{
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"in" : "query" ,
"name" : "pvforecast0_mountingplace" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "free" ,
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"title" : "Pvforecast0 Mountingplace"
}
} ,
{
"description" : "Sum of PV system losses in percent" ,
"in" : "query" ,
"name" : "pvforecast0_loss" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 14.0 ,
"description" : "Sum of PV system losses in percent" ,
"title" : "Pvforecast0 Loss"
}
} ,
{
"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." ,
"in" : "query" ,
"name" : "pvforecast0_trackingtype" ,
"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" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"in" : "query" ,
"name" : "pvforecast0_optimal_surface_tilt" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"title" : "Pvforecast0 Optimal Surface Tilt"
}
} ,
{
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"in" : "query" ,
"name" : "pvforecast0_optimalangles" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"title" : "Pvforecast0 Optimalangles"
}
} ,
{
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"in" : "query" ,
"name" : "pvforecast0_albedo" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"title" : "Pvforecast0 Albedo"
}
} ,
{
"description" : "Model of the PV modules of this plane." ,
"in" : "query" ,
"name" : "pvforecast0_module_model" ,
"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 inverter of this plane." ,
"in" : "query" ,
"name" : "pvforecast0_inverter_model" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the inverter of this plane." ,
"title" : "Pvforecast0 Inverter Model"
}
} ,
{
"description" : "AC power rating of the inverter. [W]" ,
"in" : "query" ,
"name" : "pvforecast0_inverter_paco" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "AC power rating of the inverter. [W]" ,
"title" : "Pvforecast0 Inverter Paco"
}
} ,
{
"description" : "Number of the PV modules of the strings of this plane." ,
"in" : "query" ,
"name" : "pvforecast0_modules_per_string" ,
"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 strings of the inverter of this plane." ,
"in" : "query" ,
"name" : "pvforecast0_strings_per_inverter" ,
"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" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"in" : "query" ,
"name" : "pvforecast1_surface_tilt" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"title" : "Pvforecast1 Surface Tilt"
}
} ,
{
"description" : "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)." ,
"in" : "query" ,
"name" : "pvforecast1_surface_azimuth" ,
"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" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"in" : "query" ,
"name" : "pvforecast1_userhorizon" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"title" : "Pvforecast1 Userhorizon"
}
} ,
{
"description" : "Nominal power of PV system in kW." ,
"in" : "query" ,
"name" : "pvforecast1_peakpower" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Nominal power of PV system in kW." ,
"title" : "Pvforecast1 Peakpower"
}
} ,
{
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"in" : "query" ,
"name" : "pvforecast1_pvtechchoice" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "crystSi" ,
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"title" : "Pvforecast1 Pvtechchoice"
}
} ,
{
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"in" : "query" ,
"name" : "pvforecast1_mountingplace" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "free" ,
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"title" : "Pvforecast1 Mountingplace"
}
} ,
{
"description" : "Sum of PV system losses in percent" ,
"in" : "query" ,
"name" : "pvforecast1_loss" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 14.0 ,
"description" : "Sum of PV system losses in percent" ,
"title" : "Pvforecast1 Loss"
}
} ,
{
"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." ,
"in" : "query" ,
"name" : "pvforecast1_trackingtype" ,
"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" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"in" : "query" ,
"name" : "pvforecast1_optimal_surface_tilt" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"title" : "Pvforecast1 Optimal Surface Tilt"
}
} ,
{
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"in" : "query" ,
"name" : "pvforecast1_optimalangles" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"title" : "Pvforecast1 Optimalangles"
}
} ,
{
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"in" : "query" ,
"name" : "pvforecast1_albedo" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"title" : "Pvforecast1 Albedo"
}
} ,
{
"description" : "Model of the PV modules of this plane." ,
"in" : "query" ,
"name" : "pvforecast1_module_model" ,
"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 inverter of this plane." ,
"in" : "query" ,
"name" : "pvforecast1_inverter_model" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the inverter of this plane." ,
"title" : "Pvforecast1 Inverter Model"
}
} ,
{
"description" : "AC power rating of the inverter. [W]" ,
"in" : "query" ,
"name" : "pvforecast1_inverter_paco" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "AC power rating of the inverter. [W]" ,
"title" : "Pvforecast1 Inverter Paco"
}
} ,
{
"description" : "Number of the PV modules of the strings of this plane." ,
"in" : "query" ,
"name" : "pvforecast1_modules_per_string" ,
"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 strings of the inverter of this plane." ,
"in" : "query" ,
"name" : "pvforecast1_strings_per_inverter" ,
"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" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"in" : "query" ,
"name" : "pvforecast2_surface_tilt" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"title" : "Pvforecast2 Surface Tilt"
}
} ,
{
"description" : "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)." ,
"in" : "query" ,
"name" : "pvforecast2_surface_azimuth" ,
"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" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"in" : "query" ,
"name" : "pvforecast2_userhorizon" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"title" : "Pvforecast2 Userhorizon"
}
} ,
{
"description" : "Nominal power of PV system in kW." ,
"in" : "query" ,
"name" : "pvforecast2_peakpower" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Nominal power of PV system in kW." ,
"title" : "Pvforecast2 Peakpower"
}
} ,
{
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"in" : "query" ,
"name" : "pvforecast2_pvtechchoice" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "crystSi" ,
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"title" : "Pvforecast2 Pvtechchoice"
}
} ,
{
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"in" : "query" ,
"name" : "pvforecast2_mountingplace" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "free" ,
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"title" : "Pvforecast2 Mountingplace"
}
} ,
{
"description" : "Sum of PV system losses in percent" ,
"in" : "query" ,
"name" : "pvforecast2_loss" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 14.0 ,
"description" : "Sum of PV system losses in percent" ,
"title" : "Pvforecast2 Loss"
}
} ,
{
"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." ,
"in" : "query" ,
"name" : "pvforecast2_trackingtype" ,
"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" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"in" : "query" ,
"name" : "pvforecast2_optimal_surface_tilt" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"title" : "Pvforecast2 Optimal Surface Tilt"
}
} ,
{
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"in" : "query" ,
"name" : "pvforecast2_optimalangles" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"title" : "Pvforecast2 Optimalangles"
}
} ,
{
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"in" : "query" ,
"name" : "pvforecast2_albedo" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"title" : "Pvforecast2 Albedo"
}
} ,
{
"description" : "Model of the PV modules of this plane." ,
"in" : "query" ,
"name" : "pvforecast2_module_model" ,
"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 inverter of this plane." ,
"in" : "query" ,
"name" : "pvforecast2_inverter_model" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the inverter of this plane." ,
"title" : "Pvforecast2 Inverter Model"
}
} ,
{
"description" : "AC power rating of the inverter. [W]" ,
"in" : "query" ,
"name" : "pvforecast2_inverter_paco" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "AC power rating of the inverter. [W]" ,
"title" : "Pvforecast2 Inverter Paco"
}
} ,
{
"description" : "Number of the PV modules of the strings of this plane." ,
"in" : "query" ,
"name" : "pvforecast2_modules_per_string" ,
"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 strings of the inverter of this plane." ,
"in" : "query" ,
"name" : "pvforecast2_strings_per_inverter" ,
"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" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"in" : "query" ,
"name" : "pvforecast3_surface_tilt" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"title" : "Pvforecast3 Surface Tilt"
}
} ,
{
"description" : "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)." ,
"in" : "query" ,
"name" : "pvforecast3_surface_azimuth" ,
"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" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"in" : "query" ,
"name" : "pvforecast3_userhorizon" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"title" : "Pvforecast3 Userhorizon"
}
} ,
{
"description" : "Nominal power of PV system in kW." ,
"in" : "query" ,
"name" : "pvforecast3_peakpower" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Nominal power of PV system in kW." ,
"title" : "Pvforecast3 Peakpower"
}
} ,
{
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"in" : "query" ,
"name" : "pvforecast3_pvtechchoice" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "crystSi" ,
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"title" : "Pvforecast3 Pvtechchoice"
}
} ,
{
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"in" : "query" ,
"name" : "pvforecast3_mountingplace" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "free" ,
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"title" : "Pvforecast3 Mountingplace"
}
} ,
{
"description" : "Sum of PV system losses in percent" ,
"in" : "query" ,
"name" : "pvforecast3_loss" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 14.0 ,
"description" : "Sum of PV system losses in percent" ,
"title" : "Pvforecast3 Loss"
}
} ,
{
"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." ,
"in" : "query" ,
"name" : "pvforecast3_trackingtype" ,
"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" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"in" : "query" ,
"name" : "pvforecast3_optimal_surface_tilt" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"title" : "Pvforecast3 Optimal Surface Tilt"
}
} ,
{
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"in" : "query" ,
"name" : "pvforecast3_optimalangles" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"title" : "Pvforecast3 Optimalangles"
}
} ,
{
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"in" : "query" ,
"name" : "pvforecast3_albedo" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"title" : "Pvforecast3 Albedo"
}
} ,
{
"description" : "Model of the PV modules of this plane." ,
"in" : "query" ,
"name" : "pvforecast3_module_model" ,
"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 inverter of this plane." ,
"in" : "query" ,
"name" : "pvforecast3_inverter_model" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the inverter of this plane." ,
"title" : "Pvforecast3 Inverter Model"
}
} ,
{
"description" : "AC power rating of the inverter. [W]" ,
"in" : "query" ,
"name" : "pvforecast3_inverter_paco" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "AC power rating of the inverter. [W]" ,
"title" : "Pvforecast3 Inverter Paco"
}
} ,
{
"description" : "Number of the PV modules of the strings of this plane." ,
"in" : "query" ,
"name" : "pvforecast3_modules_per_string" ,
"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 strings of the inverter of this plane." ,
"in" : "query" ,
"name" : "pvforecast3_strings_per_inverter" ,
"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" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"in" : "query" ,
"name" : "pvforecast4_surface_tilt" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"title" : "Pvforecast4 Surface Tilt"
}
} ,
{
"description" : "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)." ,
"in" : "query" ,
"name" : "pvforecast4_surface_azimuth" ,
"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" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"in" : "query" ,
"name" : "pvforecast4_userhorizon" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"title" : "Pvforecast4 Userhorizon"
}
} ,
{
"description" : "Nominal power of PV system in kW." ,
"in" : "query" ,
"name" : "pvforecast4_peakpower" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Nominal power of PV system in kW." ,
"title" : "Pvforecast4 Peakpower"
}
} ,
{
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"in" : "query" ,
"name" : "pvforecast4_pvtechchoice" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "crystSi" ,
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"title" : "Pvforecast4 Pvtechchoice"
}
} ,
{
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"in" : "query" ,
"name" : "pvforecast4_mountingplace" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "free" ,
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"title" : "Pvforecast4 Mountingplace"
}
} ,
{
"description" : "Sum of PV system losses in percent" ,
"in" : "query" ,
"name" : "pvforecast4_loss" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 14.0 ,
"description" : "Sum of PV system losses in percent" ,
"title" : "Pvforecast4 Loss"
}
} ,
{
"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." ,
"in" : "query" ,
"name" : "pvforecast4_trackingtype" ,
"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" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"in" : "query" ,
"name" : "pvforecast4_optimal_surface_tilt" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"title" : "Pvforecast4 Optimal Surface Tilt"
}
} ,
{
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"in" : "query" ,
"name" : "pvforecast4_optimalangles" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"title" : "Pvforecast4 Optimalangles"
}
} ,
{
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"in" : "query" ,
"name" : "pvforecast4_albedo" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"title" : "Pvforecast4 Albedo"
}
} ,
{
"description" : "Model of the PV modules of this plane." ,
"in" : "query" ,
"name" : "pvforecast4_module_model" ,
"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 inverter of this plane." ,
"in" : "query" ,
"name" : "pvforecast4_inverter_model" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the inverter of this plane." ,
"title" : "Pvforecast4 Inverter Model"
}
} ,
{
"description" : "AC power rating of the inverter. [W]" ,
"in" : "query" ,
"name" : "pvforecast4_inverter_paco" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "AC power rating of the inverter. [W]" ,
"title" : "Pvforecast4 Inverter Paco"
}
} ,
{
"description" : "Number of the PV modules of the strings of this plane." ,
"in" : "query" ,
"name" : "pvforecast4_modules_per_string" ,
"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 strings of the inverter of this plane." ,
"in" : "query" ,
"name" : "pvforecast4_strings_per_inverter" ,
"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" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"in" : "query" ,
"name" : "pvforecast5_surface_tilt" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Tilt angle from horizontal plane. Ignored for two-axis tracking." ,
"title" : "Pvforecast5 Surface Tilt"
}
} ,
{
"description" : "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270)." ,
"in" : "query" ,
"name" : "pvforecast5_surface_azimuth" ,
"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" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"in" : "query" ,
"name" : "pvforecast5_userhorizon" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"description" : "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north." ,
"title" : "Pvforecast5 Userhorizon"
}
} ,
{
"description" : "Nominal power of PV system in kW." ,
"in" : "query" ,
"name" : "pvforecast5_peakpower" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Nominal power of PV system in kW." ,
"title" : "Pvforecast5 Peakpower"
}
} ,
{
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"in" : "query" ,
"name" : "pvforecast5_pvtechchoice" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "crystSi" ,
"description" : "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'." ,
"title" : "Pvforecast5 Pvtechchoice"
}
} ,
{
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"in" : "query" ,
"name" : "pvforecast5_mountingplace" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "free" ,
"description" : "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated." ,
"title" : "Pvforecast5 Mountingplace"
}
} ,
{
"description" : "Sum of PV system losses in percent" ,
"in" : "query" ,
"name" : "pvforecast5_loss" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"default" : 14.0 ,
"description" : "Sum of PV system losses in percent" ,
"title" : "Pvforecast5 Loss"
}
} ,
{
"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." ,
"in" : "query" ,
"name" : "pvforecast5_trackingtype" ,
"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" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"in" : "query" ,
"name" : "pvforecast5_optimal_surface_tilt" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt angle. Ignored for two-axis tracking." ,
"title" : "Pvforecast5 Optimal Surface Tilt"
}
} ,
{
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"in" : "query" ,
"name" : "pvforecast5_optimalangles" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"description" : "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking." ,
"title" : "Pvforecast5 Optimalangles"
}
} ,
{
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"in" : "query" ,
"name" : "pvforecast5_albedo" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Proportion of the light hitting the ground that it reflects back." ,
"title" : "Pvforecast5 Albedo"
}
} ,
{
"description" : "Model of the PV modules of this plane." ,
"in" : "query" ,
"name" : "pvforecast5_module_model" ,
"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 inverter of this plane." ,
"in" : "query" ,
"name" : "pvforecast5_inverter_model" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Model of the inverter of this plane." ,
"title" : "Pvforecast5 Inverter Model"
}
} ,
{
"description" : "AC power rating of the inverter. [W]" ,
"in" : "query" ,
"name" : "pvforecast5_inverter_paco" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "AC power rating of the inverter. [W]" ,
"title" : "Pvforecast5 Inverter Paco"
}
} ,
{
"description" : "Number of the PV modules of the strings of this plane." ,
"in" : "query" ,
"name" : "pvforecast5_modules_per_string" ,
"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 strings of the inverter of this plane." ,
"in" : "query" ,
"name" : "pvforecast5_strings_per_inverter" ,
"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" : "Path to the file to import load data from." ,
"in" : "query" ,
"name" : "load_import_file_path" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Path to the file to import load data from." ,
"title" : "Load Import File Path"
}
} ,
{
"description" : "JSON string, dictionary of load forecast value lists." ,
"in" : "query" ,
"name" : "load_import_json" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "JSON string, dictionary of load forecast value lists." ,
"title" : "Load Import Json"
}
} ,
{
"description" : "Yearly energy consumption (kWh)." ,
"in" : "query" ,
"name" : "loadakkudoktor_year_energy" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Yearly energy consumption (kWh)." ,
"title" : "Loadakkudoktor Year Energy"
}
} ,
{
"description" : "Load provider id of provider to be used." ,
"in" : "query" ,
"name" : "load_provider" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Load provider id of provider to be used." ,
"title" : "Load Provider"
}
} ,
{
"description" : "Path to the file to import elecprice data from." ,
"in" : "query" ,
"name" : "elecpriceimport_file_path" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Path to the file to import elecprice data from." ,
"title" : "Elecpriceimport File Path"
}
} ,
{
"description" : "JSON string, dictionary of electricity price forecast value lists." ,
"in" : "query" ,
"name" : "elecpriceimport_json" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "JSON string, dictionary of electricity price forecast value lists." ,
"title" : "Elecpriceimport Json"
}
} ,
{
"description" : "Electricity price provider id of provider to be used." ,
"in" : "query" ,
"name" : "elecprice_provider" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Electricity price provider id of provider to be used." ,
"title" : "Elecprice Provider"
}
} ,
{
"description" : "Electricity price charges (\u20ac/kWh)." ,
"in" : "query" ,
"name" : "elecprice_charges_kwh" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"minimum" : 0.0 ,
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Electricity price charges (\u20ac/kWh)." ,
"title" : "Elecprice Charges Kwh"
}
} ,
{
"description" : "Number of hours into the future for predictions" ,
"in" : "query" ,
"name" : "prediction_hours" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"minimum" : 0 ,
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"default" : 48 ,
"description" : "Number of hours into the future for predictions" ,
"title" : "Prediction Hours"
}
} ,
{
"description" : "Number of hours into the past for historical predictions data" ,
"in" : "query" ,
"name" : "prediction_historic_hours" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"minimum" : 0 ,
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"default" : 48 ,
"description" : "Number of hours into the past for historical predictions data" ,
"title" : "Prediction Historic Hours"
}
} ,
{
"description" : "Latitude in decimal degrees, between -90 and 90, north is positive (ISO 19115) (\u00b0)" ,
"in" : "query" ,
"name" : "latitude" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"maximum" : 90.0 ,
"minimum" : -90.0 ,
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Latitude in decimal degrees, between -90 and 90, north is positive (ISO 19115) (\u00b0)" ,
"title" : "Latitude"
}
} ,
{
"description" : "Longitude in decimal degrees, within -180 to 180 (\u00b0)" ,
"in" : "query" ,
"name" : "longitude" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"maximum" : 180.0 ,
"minimum" : -180.0 ,
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Longitude in decimal degrees, within -180 to 180 (\u00b0)" ,
"title" : "Longitude"
}
} ,
{
"description" : "Number of hours into the future for optimizations." ,
"in" : "query" ,
"name" : "optimization_hours" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"minimum" : 0 ,
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"default" : 24 ,
"description" : "Number of hours into the future for optimizations." ,
"title" : "Optimization Hours"
}
} ,
{
"description" : "Penalty factor used in optimization." ,
"in" : "query" ,
"name" : "optimization_penalty" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"default" : 10 ,
"description" : "Penalty factor used in optimization." ,
"title" : "Optimization Penalty"
}
} ,
{
"description" : "Charge rates available for the EV in percent of maximum charge." ,
"in" : "query" ,
"name" : "optimization_ev_available_charge_rates_percent" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"items" : {
"type" : "number"
} ,
"type" : "array"
} ,
{
"type" : "null"
}
] ,
"default" : [
0.0 ,
0.375 ,
0.5 ,
0.625 ,
0.75 ,
0.875 ,
1.0
] ,
"description" : "Charge rates available for the EV in percent of maximum charge." ,
"title" : "Optimization Ev Available Charge Rates Percent"
}
} ,
{
"description" : "Name of the load0 source (e.g. 'Household', 'Heat Pump')" ,
"in" : "query" ,
"name" : "measurement_load0_name" ,
"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 load1 source (e.g. 'Household', 'Heat Pump')" ,
"in" : "query" ,
"name" : "measurement_load1_name" ,
"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 load2 source (e.g. 'Household', 'Heat Pump')" ,
"in" : "query" ,
"name" : "measurement_load2_name" ,
"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 load3 source (e.g. 'Household', 'Heat Pump')" ,
"in" : "query" ,
"name" : "measurement_load3_name" ,
"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 load4 source (e.g. 'Household', 'Heat Pump')" ,
"in" : "query" ,
"name" : "measurement_load4_name" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Name of the load4 source (e.g. 'Household', 'Heat Pump')" ,
"title" : "Measurement Load4 Name"
}
} ,
{
"description" : "Id of Battery simulation provider." ,
"in" : "query" ,
"name" : "battery_provider" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Id of Battery simulation provider." ,
"title" : "Battery Provider"
}
} ,
{
"description" : "Battery capacity [Wh]." ,
"in" : "query" ,
"name" : "battery_capacity" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery capacity [Wh]." ,
"title" : "Battery Capacity"
}
} ,
{
"description" : "Battery initial state of charge [%]." ,
"in" : "query" ,
"name" : "battery_initial_soc" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery initial state of charge [%]." ,
"title" : "Battery Initial Soc"
}
} ,
{
"description" : "Battery minimum state of charge [%]." ,
"in" : "query" ,
"name" : "battery_soc_min" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery minimum state of charge [%]." ,
"title" : "Battery Soc Min"
}
} ,
{
"description" : "Battery maximum state of charge [%]." ,
"in" : "query" ,
"name" : "battery_soc_max" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery maximum state of charge [%]." ,
"title" : "Battery Soc Max"
}
} ,
{
"description" : "Battery charging efficiency [%]." ,
"in" : "query" ,
"name" : "battery_charging_efficiency" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery charging efficiency [%]." ,
"title" : "Battery Charging Efficiency"
}
} ,
{
"description" : "Battery discharging efficiency [%]." ,
"in" : "query" ,
"name" : "battery_discharging_efficiency" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery discharging efficiency [%]." ,
"title" : "Battery Discharging Efficiency"
}
} ,
{
"description" : "Battery maximum charge power [W]." ,
"in" : "query" ,
"name" : "battery_max_charging_power" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery maximum charge power [W]." ,
"title" : "Battery Max Charging Power"
}
} ,
{
"description" : "Id of Battery Electric Vehicle simulation provider." ,
"in" : "query" ,
"name" : "bev_provider" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Id of Battery Electric Vehicle simulation provider." ,
"title" : "Bev Provider"
}
} ,
{
"description" : "Battery Electric Vehicle capacity [Wh]." ,
"in" : "query" ,
"name" : "bev_capacity" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery Electric Vehicle capacity [Wh]." ,
"title" : "Bev Capacity"
}
} ,
{
"description" : "Battery Electric Vehicle initial state of charge [%]." ,
"in" : "query" ,
"name" : "bev_initial_soc" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery Electric Vehicle initial state of charge [%]." ,
"title" : "Bev Initial Soc"
}
} ,
{
"description" : "Battery Electric Vehicle maximum state of charge [%]." ,
"in" : "query" ,
"name" : "bev_soc_max" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery Electric Vehicle maximum state of charge [%]." ,
"title" : "Bev Soc Max"
}
} ,
{
"description" : "Battery Electric Vehicle charging efficiency [%]." ,
"in" : "query" ,
"name" : "bev_charging_efficiency" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery Electric Vehicle charging efficiency [%]." ,
"title" : "Bev Charging Efficiency"
}
} ,
{
"description" : "Battery Electric Vehicle discharging efficiency [%]." ,
"in" : "query" ,
"name" : "bev_discharging_efficiency" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery Electric Vehicle discharging efficiency [%]." ,
"title" : "Bev Discharging Efficiency"
}
} ,
{
"description" : "Battery Electric Vehicle maximum charge power [W]." ,
"in" : "query" ,
"name" : "bev_max_charging_power" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Battery Electric Vehicle maximum charge power [W]." ,
"title" : "Bev Max Charging Power"
}
} ,
{
"description" : "Id of Dish Washer simulation provider." ,
"in" : "query" ,
"name" : "dishwasher_provider" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Id of Dish Washer simulation provider." ,
"title" : "Dishwasher Provider"
}
} ,
{
"description" : "Dish Washer energy consumption [Wh]." ,
"in" : "query" ,
"name" : "dishwasher_consumption" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Dish Washer energy consumption [Wh]." ,
"title" : "Dishwasher Consumption"
}
} ,
{
"description" : "Dish Washer usage duration [h]." ,
"in" : "query" ,
"name" : "dishwasher_duration" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "integer"
} ,
{
"type" : "null"
}
] ,
"description" : "Dish Washer usage duration [h]." ,
"title" : "Dishwasher Duration"
}
} ,
{
"description" : "Id of PV Inverter simulation provider." ,
"in" : "query" ,
"name" : "inverter_provider" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Id of PV Inverter simulation provider." ,
"title" : "Inverter Provider"
}
} ,
{
"description" : "Inverter maximum power [W]." ,
"in" : "query" ,
"name" : "inverter_power_max" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "null"
}
] ,
"description" : "Inverter maximum power [W]." ,
"title" : "Inverter Power Max"
}
} ,
{
"description" : "EOS default logging level." ,
"in" : "query" ,
"name" : "logging_level_default" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "EOS default logging level." ,
"title" : "Logging Level Default"
}
} ,
{
"description" : "Path to EOS data directory." ,
"in" : "query" ,
"name" : "data_folder_path" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Path to EOS data directory." ,
"title" : "Data Folder Path"
}
} ,
{
"description" : "Sub-path for the EOS output data directory." ,
"in" : "query" ,
"name" : "data_output_subpath" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "output" ,
"description" : "Sub-path for the EOS output data directory." ,
"title" : "Data Output Subpath"
}
} ,
{
"description" : "Sub-path for the EOS cache data directory." ,
"in" : "query" ,
"name" : "data_cache_subpath" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"format" : "path" ,
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"default" : "cache" ,
"description" : "Sub-path for the EOS cache data directory." ,
"title" : "Data Cache Subpath"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigEOS"
}
}
} ,
"description" : "Successful Response"
} ,
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HTTPValidationError"
}
}
} ,
"description" : "Validation Error"
}
2025-01-05 14:41:07 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Config Put"
2025-01-06 16:27:57 +01:00
}
2025-01-05 14:41:07 +01:00
} ,
2025-03-02 11:19:54 +01:00
"/v1/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" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SettingsEOS"
}
}
} ,
"description" : "Successful Response"
}
2025-01-05 14:41:07 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Config File Get"
} ,
"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" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigEOS"
}
}
} ,
"description" : "Successful Response"
}
} ,
"summary" : "Fastapi Config File Put"
2025-01-06 16:27:57 +01:00
}
2025-01-05 14:41:07 +01:00
} ,
2025-03-02 11:19:54 +01:00
"/v1/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" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigEOS"
}
}
} ,
"description" : "Successful Response"
}
} ,
"summary" : "Fastapi Config Update Post"
2025-01-05 14:41:07 +01:00
}
} ,
2025-03-02 11:19:54 +01:00
"/v1/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" : [
{
"description" : "configuration key" ,
"in" : "query" ,
"name" : "key" ,
"required" : true ,
"schema" : {
"description" : "configuration key" ,
"title" : "Key" ,
"type" : "string"
}
} ,
{
"description" : "configuration value" ,
"in" : "query" ,
"name" : "value" ,
"required" : true ,
"schema" : {
"description" : "configuration value" ,
"title" : "Value"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigEOS"
}
}
} ,
"description" : "Successful Response"
} ,
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HTTPValidationError"
}
}
} ,
"description" : "Validation Error"
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Config Value Put"
2025-01-03 00:31:20 +01:00
}
2025-03-02 11:19:54 +01:00
} ,
"/v1/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" : {
"content" : {
"application/json" : {
"schema" : { }
}
} ,
"description" : "Successful Response"
} ,
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HTTPValidationError"
}
}
} ,
"description" : "Validation Error"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Measurement Data Put"
2025-01-06 16:27:57 +01:00
}
2025-03-02 11:19:54 +01:00
} ,
"/v1/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" : {
"content" : {
"application/json" : {
"schema" : { }
}
} ,
"description" : "Successful Response"
} ,
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HTTPValidationError"
}
}
} ,
"description" : "Validation Error"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Measurement Dataframe Put"
2025-01-03 00:31:20 +01:00
}
2025-03-02 11:19:54 +01:00
} ,
"/v1/measurement/keys" : {
"get" : {
"description" : "Get a list of available measurement keys." ,
"operationId" : "fastapi_measurement_keys_get_v1_measurement_keys_get" ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"type" : "string"
} ,
"title" : "Response Fastapi Measurement Keys Get V1 Measurement Keys Get" ,
"type" : "array"
}
}
} ,
"description" : "Successful Response"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Measurement Keys Get"
2025-01-06 16:27:57 +01:00
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"/v1/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" : [
{
"description" : "Load name." ,
"in" : "query" ,
"name" : "name" ,
"required" : true ,
"schema" : {
"description" : "Load name." ,
"title" : "Name" ,
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PydanticDateTimeSeries"
}
}
} ,
"description" : "Successful Response"
} ,
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HTTPValidationError"
}
}
} ,
"description" : "Validation Error"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Measurement Load Mr Series By Name Get"
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"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" : [
{
"description" : "Load name." ,
"in" : "query" ,
"name" : "name" ,
"required" : true ,
"schema" : {
"description" : "Load name." ,
"title" : "Name" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PydanticDateTimeSeries"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PydanticDateTimeSeries"
}
}
} ,
"description" : "Successful Response"
} ,
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HTTPValidationError"
}
}
} ,
"description" : "Validation Error"
}
} ,
"summary" : "Fastapi Measurement Load Mr Series By Name Put"
2025-01-03 00:31:20 +01:00
}
} ,
2025-03-02 11:19:54 +01:00
"/v1/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" : [
{
"description" : "Datetime." ,
"in" : "query" ,
"name" : "datetime" ,
"required" : true ,
"schema" : {
"description" : "Datetime." ,
"title" : "Datetime" ,
"type" : "string"
}
} ,
{
"description" : "Load name." ,
"in" : "query" ,
"name" : "name" ,
"required" : true ,
"schema" : {
"description" : "Load name." ,
"title" : "Name" ,
"type" : "string"
}
} ,
{
"in" : "query" ,
"name" : "value" ,
"required" : true ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "string"
}
] ,
"title" : "Value"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PydanticDateTimeSeries"
}
}
} ,
"description" : "Successful Response"
} ,
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HTTPValidationError"
}
}
} ,
"description" : "Validation Error"
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Measurement Load Mr Value By Name Put"
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"/v1/measurement/series" : {
"get" : {
"description" : "Get the measurements of given key as series." ,
"operationId" : "fastapi_measurement_series_get_v1_measurement_series_get" ,
"parameters" : [
{
"description" : "Prediction key." ,
"in" : "query" ,
"name" : "key" ,
"required" : true ,
"schema" : {
"description" : "Prediction key." ,
"title" : "Key" ,
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PydanticDateTimeSeries"
}
}
} ,
"description" : "Successful Response"
} ,
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HTTPValidationError"
}
}
} ,
"description" : "Validation Error"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Measurement Series Get"
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"put" : {
"description" : "Merge measurement given as series into given key." ,
"operationId" : "fastapi_measurement_series_put_v1_measurement_series_put" ,
"parameters" : [
{
"description" : "Prediction key." ,
"in" : "query" ,
"name" : "key" ,
"required" : true ,
"schema" : {
"description" : "Prediction key." ,
"title" : "Key" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PydanticDateTimeSeries"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PydanticDateTimeSeries"
}
}
} ,
"description" : "Successful Response"
} ,
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HTTPValidationError"
}
}
} ,
"description" : "Validation Error"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Measurement Series Put"
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"/v1/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" : [
{
"description" : "Datetime." ,
"in" : "query" ,
"name" : "datetime" ,
"required" : true ,
"schema" : {
"description" : "Datetime." ,
"title" : "Datetime" ,
"type" : "string"
}
} ,
{
"description" : "Prediction key." ,
"in" : "query" ,
"name" : "key" ,
"required" : true ,
"schema" : {
"description" : "Prediction key." ,
"title" : "Key" ,
"type" : "string"
}
} ,
{
"in" : "query" ,
"name" : "value" ,
"required" : true ,
"schema" : {
"anyOf" : [
{
"type" : "number"
} ,
{
"type" : "string"
}
] ,
"title" : "Value"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PydanticDateTimeSeries"
}
}
} ,
"description" : "Successful Response"
} ,
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HTTPValidationError"
}
}
} ,
"description" : "Validation Error"
2025-01-03 00:31:20 +01:00
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Measurement Value Put"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"/v1/prediction/keys" : {
"get" : {
"description" : "Get a list of available prediction keys." ,
"operationId" : "fastapi_prediction_keys_get_v1_prediction_keys_get" ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"type" : "string"
} ,
"title" : "Response Fastapi Prediction Keys Get V1 Prediction Keys Get" ,
"type" : "array"
}
}
} ,
"description" : "Successful Response"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Prediction Keys Get"
2025-01-03 00:31:20 +01:00
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"/v1/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" : [
{
"description" : "Prediction key." ,
"in" : "query" ,
"name" : "key" ,
"required" : true ,
"schema" : {
"description" : "Prediction key." ,
"title" : "Key" ,
"type" : "string"
}
} ,
{
"description" : "Starting datetime (inclusive)." ,
"in" : "query" ,
"name" : "start_datetime" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Starting datetime (inclusive)." ,
"title" : "Start Datetime"
}
} ,
{
"description" : "Ending datetime (exclusive)." ,
"in" : "query" ,
"name" : "end_datetime" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Ending datetime (exclusive)." ,
"title" : "End Datetime"
}
} ,
{
"description" : "Time duration for each interval." ,
"in" : "query" ,
"name" : "interval" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Time duration for each interval." ,
"title" : "Interval"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : { } ,
"title" : "Response Fastapi Prediction List Get V1 Prediction List Get" ,
"type" : "array"
}
}
} ,
"description" : "Successful Response"
} ,
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HTTPValidationError"
}
}
} ,
"description" : "Validation Error"
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Prediction List Get"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"/v1/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" : [
{
"description" : "Prediction key." ,
"in" : "query" ,
"name" : "key" ,
"required" : true ,
"schema" : {
"description" : "Prediction key." ,
"title" : "Key" ,
"type" : "string"
}
} ,
{
"description" : "Starting datetime (inclusive)." ,
"in" : "query" ,
"name" : "start_datetime" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Starting datetime (inclusive)." ,
"title" : "Start Datetime"
}
} ,
{
"description" : "Ending datetime (exclusive)." ,
"in" : "query" ,
"name" : "end_datetime" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "null"
}
] ,
"description" : "Ending datetime (exclusive)." ,
"title" : "End Datetime"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PydanticDateTimeSeries"
}
}
} ,
"description" : "Successful Response"
} ,
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HTTPValidationError"
}
}
} ,
"description" : "Validation Error"
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Prediction Series Get"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"/v1/prediction/update" : {
"post" : {
"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" : [
{
"in" : "query" ,
"name" : "force_update" ,
"required" : false ,
"schema" : {
"default" : false ,
"title" : "Force Update" ,
"type" : "boolean"
}
} ,
{
"in" : "query" ,
"name" : "force_enable" ,
"required" : false ,
"schema" : {
"default" : false ,
"title" : "Force Enable" ,
"type" : "boolean"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : { }
}
} ,
"description" : "Successful Response"
} ,
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HTTPValidationError"
}
}
} ,
"description" : "Validation Error"
}
} ,
"summary" : "Fastapi Prediction Update"
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"/v1/prediction/update/{provider_id}" : {
"post" : {
"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" : [
{
"in" : "path" ,
"name" : "provider_id" ,
"required" : true ,
"schema" : {
"title" : "Provider Id" ,
"type" : "string"
}
} ,
{
"in" : "query" ,
"name" : "force_update" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"title" : "Force Update"
}
} ,
{
"in" : "query" ,
"name" : "force_enable" ,
"required" : false ,
"schema" : {
"anyOf" : [
{
"type" : "boolean"
} ,
{
"type" : "null"
}
] ,
"default" : false ,
"title" : "Force Enable"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : { }
}
} ,
"description" : "Successful Response"
} ,
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HTTPValidationError"
}
}
} ,
"description" : "Validation Error"
}
2025-01-03 00:31:20 +01:00
} ,
2025-03-02 11:19:54 +01:00
"summary" : "Fastapi Prediction Update Provider"
}
2025-01-06 16:27:57 +01:00
} ,
2025-03-02 11:19:54 +01:00
"/visualization_results.pdf" : {
"get" : {
"operationId" : "get_pdf_visualization_results_pdf_get" ,
"responses" : {
"200" : {
"content" : {
"application/pdf" : {
"schema" : {
"type" : "string"
}
}
} ,
"description" : "Successful Response"
}
} ,
"summary" : "Get Pdf"
}
}
2025-01-03 00:31:20 +01:00
}
}
