mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2025-04-17 07:55:15 +00:00
9ad61f66b2
* Cleanup: parameters: extra=forbid, optimize: battery, inverter optional * Don't allow extra fields for parameters/REST-API (at least for now while changing API). * Allow both battery and inverter to be set optionally (atm optional battery not implemented, no API constraints). * inverter: Remove default max_power_wh * single_test_optimization: Add more cli-parameters * Workflow docker-build: Don't try to authenticate for PRs * Secrets are not available anyway for forks.
290 lines
12 KiB
Python
290 lines
12 KiB
Python
from typing import Any, Optional
|
||
|
||
import numpy as np
|
||
from pydantic import BaseModel, Field, field_validator
|
||
|
||
from akkudoktoreos.core.logging import get_logger
|
||
from akkudoktoreos.core.pydantic import ParametersBaseModel
|
||
from akkudoktoreos.devices.devicesabc import DeviceBase
|
||
from akkudoktoreos.utils.utils import NumpyEncoder
|
||
|
||
logger = get_logger(__name__)
|
||
|
||
|
||
def max_charging_power_field(description: Optional[str] = None) -> float:
|
||
if description is None:
|
||
description = "Maximum charging power in watts."
|
||
return Field(
|
||
default=5000,
|
||
gt=0,
|
||
description=description,
|
||
)
|
||
|
||
|
||
def initial_soc_percentage_field(description: str) -> int:
|
||
return Field(default=0, ge=0, le=100, description=description)
|
||
|
||
|
||
class BaseBatteryParameters(ParametersBaseModel):
|
||
"""Base class for battery parameters with fields for capacity, efficiency, and state of charge."""
|
||
|
||
capacity_wh: int = Field(
|
||
gt=0, description="An integer representing the capacity of the battery in watt-hours."
|
||
)
|
||
charging_efficiency: float = Field(
|
||
default=0.88,
|
||
gt=0,
|
||
le=1,
|
||
description="A float representing the charging efficiency of the battery.",
|
||
)
|
||
discharging_efficiency: float = Field(
|
||
default=0.88,
|
||
gt=0,
|
||
le=1,
|
||
description="A float representing the discharge efficiency of the battery.",
|
||
)
|
||
max_charge_power_w: Optional[float] = max_charging_power_field()
|
||
initial_soc_percentage: int = initial_soc_percentage_field(
|
||
"An integer representing the state of charge of the battery at the **start** of the current hour (not the current state)."
|
||
)
|
||
min_soc_percentage: int = Field(
|
||
default=0,
|
||
ge=0,
|
||
le=100,
|
||
description="An integer representing the minimum state of charge (SOC) of the battery in percentage.",
|
||
)
|
||
max_soc_percentage: int = Field(
|
||
default=100,
|
||
ge=0,
|
||
le=100,
|
||
description="An integer representing the maximum state of charge (SOC) of the battery in percentage.",
|
||
)
|
||
|
||
|
||
class SolarPanelBatteryParameters(BaseBatteryParameters):
|
||
max_charge_power_w: Optional[float] = max_charging_power_field()
|
||
|
||
|
||
class ElectricVehicleParameters(BaseBatteryParameters):
|
||
"""Parameters specific to an electric vehicle (EV)."""
|
||
|
||
discharging_efficiency: float = 1.0
|
||
initial_soc_percentage: int = initial_soc_percentage_field(
|
||
"An integer representing the current state of charge (SOC) of the battery in percentage."
|
||
)
|
||
|
||
|
||
class ElectricVehicleResult(BaseModel):
|
||
"""Result class containing information related to the electric vehicle's charging and discharging behavior."""
|
||
|
||
charge_array: list[float] = Field(
|
||
description="Hourly charging status (0 for no charging, 1 for charging)."
|
||
)
|
||
discharge_array: list[int] = Field(
|
||
description="Hourly discharging status (0 for no discharging, 1 for discharging)."
|
||
)
|
||
discharging_efficiency: float = Field(description="The discharge efficiency as a float..")
|
||
hours: int = Field(description="Number of hours in the simulation.")
|
||
capacity_wh: int = Field(description="Capacity of the EV’s battery in watt-hours.")
|
||
charging_efficiency: float = Field(description="Charging efficiency as a float..")
|
||
max_charge_power_w: int = Field(description="Maximum charging power in watts.")
|
||
soc_wh: float = Field(
|
||
description="State of charge of the battery in watt-hours at the start of the simulation."
|
||
)
|
||
initial_soc_percentage: int = Field(
|
||
description="State of charge at the start of the simulation in percentage."
|
||
)
|
||
|
||
@field_validator("discharge_array", "charge_array", mode="before")
|
||
def convert_numpy(cls, field: Any) -> Any:
|
||
return NumpyEncoder.convert_numpy(field)[0]
|
||
|
||
|
||
class Battery(DeviceBase):
|
||
"""Represents a battery device with methods to simulate energy charging and discharging."""
|
||
|
||
def __init__(
|
||
self,
|
||
parameters: Optional[BaseBatteryParameters] = None,
|
||
hours: Optional[int] = 24,
|
||
provider_id: Optional[str] = None,
|
||
):
|
||
# Initialize configuration and parameters
|
||
self.provider_id = provider_id
|
||
self.prefix = "<invalid>"
|
||
if self.provider_id == "GenericBattery":
|
||
self.prefix = "battery"
|
||
elif self.provider_id == "GenericBEV":
|
||
self.prefix = "bev"
|
||
|
||
self.parameters = parameters
|
||
if hours is None:
|
||
self.hours = self.total_hours # TODO where does that come from?
|
||
else:
|
||
self.hours = hours
|
||
|
||
self.initialised = False
|
||
|
||
# Run setup if parameters are given, otherwise setup() has to be called later when the config is initialised.
|
||
if self.parameters is not None:
|
||
self.setup()
|
||
|
||
def setup(self) -> None:
|
||
"""Sets up the battery parameters based on configuration or provided parameters."""
|
||
if self.initialised:
|
||
return
|
||
|
||
if self.provider_id:
|
||
# Setup from configuration
|
||
self.capacity_wh = getattr(self.config, f"{self.prefix}_capacity")
|
||
self.initial_soc_percentage = getattr(self.config, f"{self.prefix}_initial_soc")
|
||
self.hours = self.total_hours # TODO where does that come from?
|
||
self.charging_efficiency = getattr(self.config, f"{self.prefix}_charging_efficiency")
|
||
self.discharging_efficiency = getattr(
|
||
self.config, f"{self.prefix}_discharging_efficiency"
|
||
)
|
||
self.max_charge_power_w = getattr(self.config, f"{self.prefix}_max_charging_power")
|
||
|
||
if self.provider_id == "GenericBattery":
|
||
self.min_soc_percentage = getattr(
|
||
self.config,
|
||
f"{self.prefix}_soc_min",
|
||
)
|
||
else:
|
||
self.min_soc_percentage = 0
|
||
|
||
self.max_soc_percentage = getattr(
|
||
self.config,
|
||
f"{self.prefix}_soc_max",
|
||
)
|
||
elif self.parameters:
|
||
# Setup from parameters
|
||
self.capacity_wh = self.parameters.capacity_wh
|
||
self.initial_soc_percentage = self.parameters.initial_soc_percentage
|
||
self.charging_efficiency = self.parameters.charging_efficiency
|
||
self.discharging_efficiency = self.parameters.discharging_efficiency
|
||
self.max_charge_power_w = self.parameters.max_charge_power_w
|
||
# Only assign for storage battery
|
||
self.min_soc_percentage = (
|
||
self.parameters.min_soc_percentage
|
||
if isinstance(self.parameters, SolarPanelBatteryParameters)
|
||
else 0
|
||
)
|
||
self.max_soc_percentage = self.parameters.max_soc_percentage
|
||
else:
|
||
error_msg = "Parameters and provider ID are missing. Cannot instantiate."
|
||
logger.error(error_msg)
|
||
raise ValueError(error_msg)
|
||
|
||
# Initialize state of charge
|
||
if self.max_charge_power_w is None:
|
||
self.max_charge_power_w = self.capacity_wh # TODO this should not be equal capacity_wh
|
||
self.discharge_array = np.full(self.hours, 1)
|
||
self.charge_array = np.full(self.hours, 1)
|
||
self.soc_wh = (self.initial_soc_percentage / 100) * self.capacity_wh
|
||
self.min_soc_wh = (self.min_soc_percentage / 100) * self.capacity_wh
|
||
self.max_soc_wh = (self.max_soc_percentage / 100) * self.capacity_wh
|
||
|
||
self.initialised = True
|
||
|
||
def to_dict(self) -> dict[str, Any]:
|
||
"""Converts the object to a dictionary representation."""
|
||
return {
|
||
"capacity_wh": self.capacity_wh,
|
||
"initial_soc_percentage": self.initial_soc_percentage,
|
||
"soc_wh": self.soc_wh,
|
||
"hours": self.hours,
|
||
"discharge_array": self.discharge_array,
|
||
"charge_array": self.charge_array,
|
||
"charging_efficiency": self.charging_efficiency,
|
||
"discharging_efficiency": self.discharging_efficiency,
|
||
"max_charge_power_w": self.max_charge_power_w,
|
||
}
|
||
|
||
def reset(self) -> None:
|
||
"""Resets the battery state to its initial values."""
|
||
self.soc_wh = (self.initial_soc_percentage / 100) * self.capacity_wh
|
||
self.soc_wh = min(max(self.soc_wh, self.min_soc_wh), self.max_soc_wh)
|
||
self.discharge_array = np.full(self.hours, 1)
|
||
self.charge_array = np.full(self.hours, 1)
|
||
|
||
def set_discharge_per_hour(self, discharge_array: np.ndarray) -> None:
|
||
"""Sets the discharge values for each hour."""
|
||
if len(discharge_array) != self.hours:
|
||
raise ValueError(f"Discharge array must have exactly {self.hours} elements.")
|
||
self.discharge_array = np.array(discharge_array)
|
||
|
||
def set_charge_per_hour(self, charge_array: np.ndarray) -> None:
|
||
"""Sets the charge values for each hour."""
|
||
if len(charge_array) != self.hours:
|
||
raise ValueError(f"Charge array must have exactly {self.hours} elements.")
|
||
self.charge_array = np.array(charge_array)
|
||
|
||
def set_charge_allowed_for_hour(self, charge: float, hour: int) -> None:
|
||
"""Sets the charge for a specific hour."""
|
||
if hour >= self.hours:
|
||
raise ValueError(f"Hour {hour} is out of range. Must be less than {self.hours}.")
|
||
self.charge_array[hour] = charge
|
||
|
||
def current_soc_percentage(self) -> float:
|
||
"""Calculates the current state of charge in percentage."""
|
||
return (self.soc_wh / self.capacity_wh) * 100
|
||
|
||
def discharge_energy(self, wh: float, hour: int) -> tuple[float, float]:
|
||
"""Discharges energy from the battery."""
|
||
if self.discharge_array[hour] == 0:
|
||
return 0.0, 0.0
|
||
|
||
max_possible_discharge_wh = (self.soc_wh - self.min_soc_wh) * self.discharging_efficiency
|
||
max_possible_discharge_wh = max(max_possible_discharge_wh, 0.0)
|
||
|
||
max_possible_discharge_wh = min(
|
||
max_possible_discharge_wh, self.max_charge_power_w
|
||
) # TODO make a new cfg variable max_discharge_power_w
|
||
|
||
actual_discharge_wh = min(wh, max_possible_discharge_wh)
|
||
actual_withdrawal_wh = (
|
||
actual_discharge_wh / self.discharging_efficiency
|
||
if self.discharging_efficiency > 0
|
||
else 0.0
|
||
)
|
||
|
||
self.soc_wh -= actual_withdrawal_wh
|
||
self.soc_wh = max(self.soc_wh, self.min_soc_wh)
|
||
|
||
losses_wh = actual_withdrawal_wh - actual_discharge_wh
|
||
return actual_discharge_wh, losses_wh
|
||
|
||
def charge_energy(
|
||
self, wh: Optional[float], hour: int, relative_power: float = 0.0
|
||
) -> tuple[float, float]:
|
||
"""Charges energy into the battery."""
|
||
if hour is not None and self.charge_array[hour] == 0:
|
||
return 0.0, 0.0 # Charging not allowed in this hour
|
||
|
||
if relative_power > 0.0:
|
||
wh = self.max_charge_power_w * relative_power
|
||
|
||
wh = wh if wh is not None else self.max_charge_power_w
|
||
|
||
max_possible_charge_wh = (
|
||
(self.max_soc_wh - self.soc_wh) / self.charging_efficiency
|
||
if self.charging_efficiency > 0
|
||
else 0.0
|
||
)
|
||
max_possible_charge_wh = max(max_possible_charge_wh, 0.0)
|
||
|
||
effective_charge_wh = min(wh, max_possible_charge_wh)
|
||
charged_wh = effective_charge_wh * self.charging_efficiency
|
||
|
||
self.soc_wh += charged_wh
|
||
self.soc_wh = min(self.soc_wh, self.max_soc_wh)
|
||
|
||
losses_wh = effective_charge_wh - charged_wh
|
||
return charged_wh, losses_wh
|
||
|
||
def current_energy_content(self) -> float:
|
||
"""Returns the current usable energy in the battery."""
|
||
usable_energy = (self.soc_wh - self.min_soc_wh) * self.discharging_efficiency
|
||
return max(usable_energy, 0.0)
|