Mirrors/EOS
1
0
Fork 0
mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2025-09-13 07:21:16 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

translation of battery.py v3 (#262)

Browse Source
This commit is contained in:
Normann
2024-12-19 14:50:19 +01:00
committed by GitHub
parent 0e122a9a49
commit 5f898e8aab
18 changed files with 684 additions and 648 deletions
Download Patch File Download Diff File Expand all files Collapse all files

295
docs/akkudoktoreos/openapi.json
View File

@@ -2091,7 +2091,7 @@
"title": "Battery Capacity",
"description": "Battery capacity [Wh]."
},
"battery_soc_start": {
"battery_initial_soc": {
"anyOf": [
{
"type": "integer"
@@ -2100,7 +2100,7 @@
"type": "null"
}
],
"title": "Battery Soc Start",
"title": "Battery Initial Soc",
"description": "Battery initial state of charge [%]."
},
"battery_soc_min": {
@@ -2127,7 +2127,7 @@
"title": "Battery Soc Max",
"description": "Battery maximum state of charge [%]."
},
"battery_charge_efficiency": {
"battery_charging_efficiency": {
"anyOf": [
{
"type": "number"
@@ -2136,10 +2136,10 @@
"type": "null"
}
],
"title": "Battery Charge Efficiency",
"title": "Battery Charging Efficiency",
"description": "Battery charging efficiency [%]."
},
"battery_discharge_efficiency": {
"battery_discharging_efficiency": {
"anyOf": [
{
"type": "number"
@@ -2148,10 +2148,10 @@
"type": "null"
}
],
"title": "Battery Discharge Efficiency",
"title": "Battery Discharging Efficiency",
"description": "Battery discharging efficiency [%]."
},
"battery_charge_power_max": {
"battery_max_charging_power": {
"anyOf": [
{
"type": "integer"
@@ -2160,7 +2160,7 @@
"type": "null"
}
],
"title": "Battery Charge Power Max",
"title": "Battery Max Charging Power",
"description": "Battery maximum charge power [W]."
},
"bev_provider": {
@@ -2187,7 +2187,7 @@
"title": "Bev Capacity",
"description": "Battery Electric Vehicle capacity [Wh]."
},
"bev_soc_start": {
"bev_initial_soc": {
"anyOf": [
{
"type": "integer"
@@ -2196,7 +2196,7 @@
"type": "null"
}
],
"title": "Bev Soc Start",
"title": "Bev Initial Soc",
"description": "Battery Electric Vehicle initial state of charge [%]."
},
"bev_soc_max": {
@@ -2211,7 +2211,7 @@
"title": "Bev Soc Max",
"description": "Battery Electric Vehicle maximum state of charge [%]."
},
"bev_charge_efficiency": {
"bev_charging_efficiency": {
"anyOf": [
{
"type": "number"
@@ -2220,10 +2220,10 @@
"type": "null"
}
],
"title": "Bev Charge Efficiency",
"title": "Bev Charging Efficiency",
"description": "Battery Electric Vehicle charging efficiency [%]."
},
"bev_discharge_efficiency": {
"bev_discharging_efficiency": {
"anyOf": [
{
"type": "number"
@@ -2232,10 +2232,10 @@
"type": "null"
}
],
"title": "Bev Discharge Efficiency",
"title": "Bev Discharging Efficiency",
"description": "Battery Electric Vehicle discharging efficiency [%]."
},
"bev_charge_power_max": {
"bev_max_charging_power": {
"anyOf": [
{
"type": "integer"
@@ -2244,7 +2244,7 @@
"type": "null"
}
],
"title": "Bev Charge Power Max",
"title": "Bev Max Charging Power",
"description": "Battery Electric Vehicle maximum charge power [W]."
},
"dishwasher_provider": {
@@ -2485,28 +2485,28 @@
"title": "ConfigEOS",
"description": "Singleton configuration handler for the EOS application.\n\nConfigEOS extends `SettingsEOS` with support for default configuration paths and automatic\ninitialization.\n\n`ConfigEOS` ensures that only one instance of the class is created throughout the application,\nallowing consistent access to EOS configuration settings. This singleton instance loads\nconfiguration data from a predefined set of directories or creates a default configuration if\nnone is found.\n\nInitialization Process:\n - Upon instantiation, the singleton instance attempts to load a configuration file in this order:\n 1. The directory specified by the `EOS_DIR` environment variable.\n 2. A platform specific default directory for EOS.\n 3. 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 ```"
},
"EAutoParameters": {
"ElectricVehicleParameters": {
"properties": {
"kapazitaet_wh": {
"capacity_wh": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Kapazitaet Wh",
"title": "Capacity Wh",
"description": "An integer representing the capacity of the battery in watt-hours."
},
"lade_effizienz": {
"charging_efficiency": {
"type": "number",
"maximum": 1.0,
"exclusiveMinimum": 0.0,
"title": "Lade Effizienz",
"title": "Charging Efficiency",
"description": "A float representing the charging efficiency of the battery.",
"default": 0.88
},
"entlade_effizienz": {
"discharging_efficiency": {
"type": "number",
"title": "Entlade Effizienz",
"title": "Discharging Efficiency",
"default": 1.0
},
"max_ladeleistung_w": {
"max_charge_power_w": {
"anyOf": [
{
"type": "number",
@@ -2516,38 +2516,41 @@
"type": "null"
}
],
"title": "Max Ladeleistung W",
"description": "An integer representing the charging power of the battery in watts."
"title": "Max Charge Power W",
"description": "Maximum charging power in watts.",
"default": 5000
},
"start_soc_prozent": {
"initial_soc_percentage": {
"type": "integer",
"maximum": 100.0,
"minimum": 0.0,
"title": "Start Soc Prozent",
"title": "Initial Soc Percentage",
"description": "An integer representing the current state of charge (SOC) of the battery in percentage.",
"default": 0
},
"min_soc_prozent": {
"min_soc_percentage": {
"type": "integer",
"maximum": 100.0,
"minimum": 0.0,
"title": "Min Soc Prozent",
"title": "Min Soc Percentage",
"description": "An integer representing the minimum state of charge (SOC) of the battery in percentage.",
"default": 0
},
"max_soc_prozent": {
"max_soc_percentage": {
"type": "integer",
"maximum": 100.0,
"minimum": 0.0,
"title": "Max Soc Prozent",
"title": "Max Soc Percentage",
"description": "An integer representing the maximum state of charge (SOC) of the battery in percentage.",
"default": 100
}
},
"type": "object",
"required": ["kapazitaet_wh"],
"title": "EAutoParameters"
"required": ["capacity_wh"],
"title": "ElectricVehicleParameters",
"description": "Parameters specific to an electric vehicle (EV)."
},
"EAutoResult": {
"ElectricVehicleResult": {
"properties": {
"charge_array": {
"items": {
@@ -2555,7 +2558,7 @@
},
"type": "array",
"title": "Charge Array",
"description": "Indicates for each hour whether the EV is charging (`0` for no charging, `1` for charging)."
"description": "Hourly charging status (0 for no charging, 1 for charging)."
},
"discharge_array": {
"items": {
@@ -2563,58 +2566,58 @@
},
"type": "array",
"title": "Discharge Array",
"description": "Indicates for each hour whether the EV is discharging (`0` for no discharging, `1` for discharging)."
"description": "Hourly discharging status (0 for no discharging, 1 for discharging)."
},
"entlade_effizienz": {
"discharging_efficiency": {
"type": "number",
"title": "Entlade Effizienz",
"description": "The discharge efficiency as a float."
"title": "Discharging Efficiency",
"description": "The discharge efficiency as a float.."
},
"hours": {
"type": "integer",
"title": "Hours",
"description": "Amount of hours the simulation is done for."
"description": "Number of hours in the simulation."
},
"kapazitaet_wh": {
"capacity_wh": {
"type": "integer",
"title": "Kapazitaet Wh",
"description": "The capacity of the EV\u2019s battery in watt-hours."
"title": "Capacity Wh",
"description": "Capacity of the EV\u2019s battery in watt-hours."
},
"lade_effizienz": {
"charging_efficiency": {
"type": "number",
"title": "Lade Effizienz",
"description": "The charging efficiency as a float."
"title": "Charging Efficiency",
"description": "Charging efficiency as a float.."
},
"max_ladeleistung_w": {
"max_charge_power_w": {
"type": "integer",
"title": "Max Ladeleistung W",
"description": "The maximum charging power of the EV in watts."
"title": "Max Charge Power W",
"description": "Maximum charging power in watts."
},
"soc_wh": {
"type": "number",
"title": "Soc Wh",
"description": "The state of charge of the battery in watt-hours at the start of the simulation."
"description": "State of charge of the battery in watt-hours at the start of the simulation."
},
"start_soc_prozent": {
"initial_soc_percentage": {
"type": "integer",
"title": "Start Soc Prozent",
"description": "The state of charge of the battery in percentage at the start of the simulation."
"title": "Initial Soc Percentage",
"description": "State of charge at the start of the simulation in percentage."
}
},
"type": "object",
"required": [
"charge_array",
"discharge_array",
"entlade_effizienz",
"discharging_efficiency",
"hours",
"kapazitaet_wh",
"lade_effizienz",
"max_ladeleistung_w",
"capacity_wh",
"charging_efficiency",
"max_charge_power_w",
"soc_wh",
"start_soc_prozent"
"initial_soc_percentage"
],
"title": "EAutoResult",
"description": "This object contains information related to the electric vehicle and its charging and discharging behavior."
"title": "ElectricVehicleResult",
"description": "Result class containing information related to the electric vehicle's charging and discharging behavior."
},
"EnergieManagementSystemParameters": {
"properties": {
@@ -2766,7 +2769,7 @@
"$ref": "#/components/schemas/EnergieManagementSystemParameters"
},
"pv_akku": {
"$ref": "#/components/schemas/PVAkkuParameters"
"$ref": "#/components/schemas/SolarPanelBatteryParameters"
},
"inverter": {
"$ref": "#/components/schemas/InverterParameters",
@@ -2777,7 +2780,7 @@
"eauto": {
"anyOf": [
{
"$ref": "#/components/schemas/EAutoParameters"
"$ref": "#/components/schemas/ElectricVehicleParameters"
},
{
"type": "null"
@@ -2876,7 +2879,7 @@
"eauto_obj": {
"anyOf": [
{
"$ref": "#/components/schemas/EAutoResult"
"$ref": "#/components/schemas/ElectricVehicleResult"
},
{
"type": "null"
@@ -2923,71 +2926,6 @@
"title": "OptimizeResponse",
"description": "**Note**: The first value of \"Last_Wh_per_hour\", \"Netzeinspeisung_Wh_per_hour\", and \"Netzbezug_Wh_per_hour\", will be set to null in the JSON output and represented as NaN or None in the corresponding classes' data returns. This approach is adopted to ensure that the current hour's processing remains unchanged."
},
"PVAkkuParameters": {
"properties": {
"kapazitaet_wh": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Kapazitaet Wh",
"description": "An integer representing the capacity of the battery in watt-hours."
},
"lade_effizienz": {
"type": "number",
"maximum": 1.0,
"exclusiveMinimum": 0.0,
"title": "Lade Effizienz",
"description": "A float representing the charging efficiency of the battery.",
"default": 0.88
},
"entlade_effizienz": {
"type": "number",
"maximum": 1.0,
"exclusiveMinimum": 0.0,
"title": "Entlade Effizienz",
"default": 0.88
},
"max_ladeleistung_w": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Max Ladeleistung W",
"description": "An integer representing the charging power of the battery in watts.",
"default": 5000
},
"start_soc_prozent": {
"type": "integer",
"maximum": 100.0,
"minimum": 0.0,
"title": "Start Soc Prozent",
"description": "An integer representing the state of charge of the battery at the **start** of the current hour (not the current state).",
"default": 0
},
"min_soc_prozent": {
"type": "integer",
"maximum": 100.0,
"minimum": 0.0,
"title": "Min Soc Prozent",
"description": "An integer representing the minimum state of charge (SOC) of the battery in percentage.",
"default": 0
},
"max_soc_prozent": {
"type": "integer",
"maximum": 100.0,
"minimum": 0.0,
"title": "Max Soc Prozent",
"default": 100
}
},
"type": "object",
"required": ["kapazitaet_wh"],
"title": "PVAkkuParameters"
},
"SettingsEOS": {
"properties": {
"server_fastapi_host": {
@@ -4568,7 +4506,7 @@
"title": "Battery Capacity",
"description": "Battery capacity [Wh]."
},
"battery_soc_start": {
"battery_initial_soc": {
"anyOf": [
{
"type": "integer"
@@ -4577,7 +4515,7 @@
"type": "null"
}
],
"title": "Battery Soc Start",
"title": "Battery Initial Soc",
"description": "Battery initial state of charge [%]."
},
"battery_soc_min": {
@@ -4604,7 +4542,7 @@
"title": "Battery Soc Max",
"description": "Battery maximum state of charge [%]."
},
"battery_charge_efficiency": {
"battery_charging_efficiency": {
"anyOf": [
{
"type": "number"
@@ -4613,10 +4551,10 @@
"type": "null"
}
],
"title": "Battery Charge Efficiency",
"title": "Battery Charging Efficiency",
"description": "Battery charging efficiency [%]."
},
"battery_discharge_efficiency": {
"battery_discharging_efficiency": {
"anyOf": [
{
"type": "number"
@@ -4625,10 +4563,10 @@
"type": "null"
}
],
"title": "Battery Discharge Efficiency",
"title": "Battery Discharging Efficiency",
"description": "Battery discharging efficiency [%]."
},
"battery_charge_power_max": {
"battery_max_charging_power": {
"anyOf": [
{
"type": "integer"
@@ -4637,7 +4575,7 @@
"type": "null"
}
],
"title": "Battery Charge Power Max",
"title": "Battery Max Charging Power",
"description": "Battery maximum charge power [W]."
},
"bev_provider": {
@@ -4664,7 +4602,7 @@
"title": "Bev Capacity",
"description": "Battery Electric Vehicle capacity [Wh]."
},
"bev_soc_start": {
"bev_initial_soc": {
"anyOf": [
{
"type": "integer"
@@ -4673,7 +4611,7 @@
"type": "null"
}
],
"title": "Bev Soc Start",
"title": "Bev Initial Soc",
"description": "Battery Electric Vehicle initial state of charge [%]."
},
"bev_soc_max": {
@@ -4688,7 +4626,7 @@
"title": "Bev Soc Max",
"description": "Battery Electric Vehicle maximum state of charge [%]."
},
"bev_charge_efficiency": {
"bev_charging_efficiency": {
"anyOf": [
{
"type": "number"
@@ -4697,10 +4635,10 @@
"type": "null"
}
],
"title": "Bev Charge Efficiency",
"title": "Bev Charging Efficiency",
"description": "Battery Electric Vehicle charging efficiency [%]."
},
"bev_discharge_efficiency": {
"bev_discharging_efficiency": {
"anyOf": [
{
"type": "number"
@@ -4709,10 +4647,10 @@
"type": "null"
}
],
"title": "Bev Discharge Efficiency",
"title": "Bev Discharging Efficiency",
"description": "Battery Electric Vehicle discharging efficiency [%]."
},
"bev_charge_power_max": {
"bev_max_charging_power": {
"anyOf": [
{
"type": "integer"
@@ -4721,7 +4659,7 @@
"type": "null"
}
],
"title": "Bev Charge Power Max",
"title": "Bev Max Charging Power",
"description": "Battery Electric Vehicle maximum charge power [W]."
},
"dishwasher_provider": {
@@ -5007,6 +4945,73 @@
"title": "SimulationResult",
"description": "This object contains the results of the simulation and provides insights into various parameters over the entire forecast period."
},
"SolarPanelBatteryParameters": {
"properties": {
"capacity_wh": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Capacity Wh",
"description": "An integer representing the capacity of the battery in watt-hours."
},
"charging_efficiency": {
"type": "number",
"maximum": 1.0,
"exclusiveMinimum": 0.0,
"title": "Charging Efficiency",
"description": "A float representing the charging efficiency of the battery.",
"default": 0.88
},
"discharging_efficiency": {
"type": "number",
"maximum": 1.0,
"exclusiveMinimum": 0.0,
"title": "Discharging Efficiency",
"description": "A float representing the discharge efficiency of the battery.",
"default": 0.88
},
"max_charge_power_w": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Max Charge Power W",
"description": "Maximum charging power in watts.",
"default": 5000
},
"initial_soc_percentage": {
"type": "integer",
"maximum": 100.0,
"minimum": 0.0,
"title": "Initial Soc Percentage",
"description": "An integer representing the state of charge of the battery at the **start** of the current hour (not the current state).",
"default": 0
},
"min_soc_percentage": {
"type": "integer",
"maximum": 100.0,
"minimum": 0.0,
"title": "Min Soc Percentage",
"description": "An integer representing the minimum state of charge (SOC) of the battery in percentage.",
"default": 0
},
"max_soc_percentage": {
"type": "integer",
"maximum": 100.0,
"minimum": 0.0,
"title": "Max Soc Percentage",
"description": "An integer representing the maximum state of charge (SOC) of the battery in percentage.",
"default": 100
}
},
"type": "object",
"required": ["capacity_wh"],
"title": "SolarPanelBatteryParameters"
},
"ValidationError": {
"properties": {
"loc": {