EOS/src/akkudoktoreos/prediction/elecpricefixed.py

"""Provides fixed price electricity price data."""

from typing import Optional

from loguru import logger
from pydantic import Field

from akkudoktoreos.config.configabc import (
    SettingsBaseModel,
    ValueTimeWindowSequence,
)
from akkudoktoreos.prediction.elecpriceabc import ElecPriceProvider
from akkudoktoreos.utils.datetimeutil import to_duration


class ElecPriceFixedCommonSettings(SettingsBaseModel):
    """Common configuration settings for fixed electricity pricing.

    This model defines a fixed electricity price schedule using a sequence
    of time windows. Each window specifies a time interval and the electricity
    price applicable during that interval.
    """

    time_windows: ValueTimeWindowSequence = Field(
        default_factory=ValueTimeWindowSequence,
        json_schema_extra={
            "description": (
                "Sequence of time windows defining the fixed "
                "price schedule. If not provided, no fixed pricing is applied."
            ),
            "examples": [
                {
                    "windows": [
                        {"start_time": "00:00", "duration": "8 hours", "value": 0.288},
                        {"start_time": "08:00", "duration": "16 hours", "value": 0.34},
                    ],
                }
            ],
        },
    )


class ElecPriceFixed(ElecPriceProvider):
    """Fixed price electricity price data.

    ElecPriceFixed is a singleton-based class that retrieves electricity price data
    from a fixed schedule defined by time windows.

    The provider generates hourly electricity prices based on the configured time windows.
    For each hour in the forecast period, it determines which time window applies and
    assigns the corresponding price.

    Attributes:
        time_windows: Sequence of time windows with associated electricity prices.
    """

    @classmethod
    def provider_id(cls) -> str:
        """Return the unique identifier for the ElecPriceFixed provider."""
        return "ElecPriceFixed"

    async def _update_data(self, force_update: Optional[bool] = False) -> None:
        """Update electricity price data from fixed schedule.

        Generates electricity prices based on the configured time windows
        at the optimization interval granularity. The price sequence starts
        synchronized to the wall clock at the next full interval boundary.

        Args:
            force_update: If True, forces update even if data exists.

        Raises:
            ValueError: If no time windows are configured.
        """
        time_windows_seq = self.config.elecprice.elecpricefixed.time_windows

        if time_windows_seq is None or not time_windows_seq.windows:
            error_msg = "No time windows configured for fixed electricity price"
            logger.error(error_msg)
            raise ValueError(error_msg)

        start_datetime = self.ems_start_datetime
        interval_seconds = 900  # Usual smallest time interval (15 min) used in electricty prices
        total_hours = self.config.prediction.hours
        interval = to_duration(interval_seconds)

        end_datetime = start_datetime.add(hours=total_hours)

        logger.debug(
            f"Generating fixed electricity prices for {total_hours} hours "
            f"starting at {start_datetime}"
        )

        # Build the full price array in one call — kWh values aligned to the
        # optimization grid.  to_array mirrors the key_to_array signature so
        # the grid is constructed identically to how prediction data is read.
        prices_kwh = time_windows_seq.to_array(
            start_datetime=start_datetime,
            end_datetime=end_datetime,
            interval=interval,
            dropna=True,
            boundary="context",
            align_to_interval=True,
        )

        # Convert kWh → Wh and store one entry per interval step.
        for idx, price_kwh in enumerate(prices_kwh):
            current_dt = start_datetime.add(seconds=idx * interval_seconds)
            await self.update_value(current_dt, "elecprice_marketprice_wh", price_kwh / 1000.0)

        logger.debug(f"Successfully generated {len(prices_kwh)} fixed electricity price entries")