Mirrors/EOS
1
0
Fork 0
mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2026-07-20 00:38:12 +00:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity
Files
75548990e13994bfd350a77c8e9fd89c95963fa1
EOS/docs/_generated/openapi.md
Bobby Noelte 75548990e1
Some checks failed
Bump Version / Bump Version Workflow (push) Has been cancelled
Details
CodeQL Advanced / Analyze (actions) (push) Has been cancelled
Details
CodeQL Advanced / Analyze (python) (push) Has been cancelled
Details
docker-build / platform-excludes (push) Has been cancelled
Details
docker-build / build (push) Has been cancelled
Details
docker-build / merge (push) Has been cancelled
Details
pre-commit / pre-commit (push) Has been cancelled
Details
Run Pytest on Pull Request / test (push) Has been cancelled
Details
feat: add cloud PV forecast providers: pvnode.com, forecast-solar and solcast (#1150) 
This PR adds three native PV power forecast providers, giving operators more
cloud forecast sources to choose from via pvforecast.provider, alongside the
existing PVForecastAkkudoktor, PVForecastVrm and PVForecastImport:

    PVForecastPVNode — native 15-minute forecasts from the pvnode.com
    V2 API. Saved-site mode (GET /v2/forecast/{site_id}) where the operator enters their API key +
    site id, or inline mode (POST /v2/forecast/inline) using the configured planes.
    PVForecastForecastSolar — the free Forecast.Solar API (no key
    required for the public endpoint). Multi-plane systems issue one request per plane and the
    instantaneous powers are summed per timestamp.
    PVForecastSolcast — the Solcast rooftop-site API (API key + resource id).

Implementation notes

    All three populate the existing pvforecast_ac_power (and mirror pvforecast_dc_power)
    prediction keys, so they slot into the optimizer unchanged.
    Timezone handling: pvnode and Forecast.Solar return site-local wall-clock timestamps with an
    IANA timezone field, which are resolved to absolute instants before resampling; Solcast returns
    UTC period_end and is normalised to the period start.
    Each provider follows the existing provider pattern (provider_id(), _request_forecast() with
    @cache_in_file, _update_data()), is registered in pvforecast.py and prediction.py, and is
    upstream-neutral.

Validation

    27 unit tests (timezone resolution, null/zero handling, kW→W and period-start conversion,
    azimuth conversion, multi-plane summation, request URL/auth, HTTP-error handling).
    ruff check (F/D/S/bandit) and ruff format clean.
    Each provider was additionally validated against its live API with a real plant, confirming
    the response shapes (pvnode: 288 native 15-min slots; Forecast.Solar: instantaneous watts;
    Solcast: kW estimates with period_end/PT30M).

Documentation

    Provider descriptions and configuration examples added to docs/akkudoktoreos/prediction.md.
    CHANGELOG.md entry under Unreleased.
    Regenerated docs/_generated/configpvforecast.md and configexample.md.

Notes for reviewers

Forecast.Solar's free endpoint is rate-limited (12 req/hour) and Solcast's free tier limits daily
calls; both providers rely on the standard 1-hour cache_in_file TTL to stay within budget.

Authors:

The code is created by Christin. Only minor adaptions by Bobby.

Signed-off-by: Christin <info@bikinibottom.capital>
Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
Co-authored-by: Christin <info@bikinibottom.capital>
2026-07-17 16:51:00 +02:00

39 KiB
Raw Blame History

Akkudoktor-EOS

Version: v0.3.0.dev2607161979035365

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.

Base URL: No base URL provided.

Endpoints:

POST /gesamtlast

Links: local, eos

Fastapi Gesamtlast

"""
Deprecated: Total Load Prediction with adjustment.

Endpoint to handle total load prediction adjusted by latest measured data.

Total load prediction starts at 00.00.00 today and is provided for 48 hours.
If no prediction values are available the missing ones at the start of the series are
filled with the first available prediction value.

Note:
    Use '/v1/prediction/list?key=loadforecast_power_w' instead.
    Load energy meter readings to be added to EOS measurement by:
    '/v1/measurement/value' or
    '/v1/measurement/series' or
    '/v1/measurement/dataframe' or
    '/v1/measurement/data'
"""

Request Body:

  • application/json: { "$ref": "#/components/schemas/GesamtlastRequest" }

Responses:

  • 200: Successful Response

  • 422: Validation Error

GET /gesamtlast_simple

Links: local, eos

Fastapi Gesamtlast Simple

"""
Deprecated: Total Load Prediction.

Endpoint to handle total load prediction.

Total load prediction starts at 00.00.00 today and is provided for 48 hours.
If no prediction values are available the missing ones at the start of the series are
filled with the first available prediction value.

Args:
    year_energy (float): Yearly energy consumption in Wh.

Note:
    Set LoadAkkudoktor as provider, then update data with
    '/v1/prediction/update'
    and then request data with
    '/v1/prediction/list?key=loadforecast_power_w' instead.
"""

Parameters:

  • year_energy (query, required): No description provided.

Responses:

  • 200: Successful Response

  • 422: Validation Error

POST /optimize

Links: local, eos

Fastapi Optimize

"""
Deprecated: Optimize.

Endpoint to handle optimization.

Note:
    Use automatic optimization instead.
"""

Parameters:

  • start_hour (query, optional): Defaults to current hour of the day.

  • ngen (query, optional): Number of indivuals to generate for genetic algorithm.

Request Body:

  • application/json: { "$ref": "#/components/schemas/GeneticOptimizationParameters" }

Responses:

  • 200: Successful Response

  • 422: Validation Error

GET /pvforecast

Links: local, eos

Fastapi Pvforecast

"""
Deprecated: PV Forecast Prediction.

Endpoint to handle PV forecast prediction.

PVForecast starts at 00.00.00 today and is provided for 48 hours.
If no forecast values are available the missing ones at the start of the series are
filled with the first available forecast value.

Note:
    Set PVForecastAkkudoktor as provider, then update data with
    '/v1/prediction/update'
    and then request data with
    '/v1/prediction/list?key=pvforecast_ac_power' and
    '/v1/prediction/list?key=pvforecastakkudoktor_temp_air' instead.
"""

Responses:

  • 200: Successful Response

GET /strompreis

Links: local, eos

Fastapi Strompreis

"""
Deprecated: Electricity Market Price Prediction per Wh (€/Wh).

Electricity prices start at 00.00.00 today and are provided for 48 hours.
If no prices are available the missing ones at the start of the series are
filled with the first available price.

Note:
    Electricity price charges are added.

Note:
    Set ElecPriceAkkudoktor as provider, then update data with
    '/v1/prediction/update'
    and then request data with
    '/v1/prediction/list?key=elecprice_marketprice_wh' or
    '/v1/prediction/list?key=elecprice_marketprice_kwh' instead.
"""

Responses:

  • 200: Successful Response

GET /v1/admin/cache

Links: local, eos

Fastapi Admin Cache Get

"""
Current cache management data.

Returns:
    data (dict): The management data.
"""

Responses:

  • 200: Successful Response

POST /v1/admin/cache/clear

Links: local, eos

Fastapi Admin Cache Clear Post

"""
Clear the cache.

Deletes all cache files.

Returns:
    data (dict): The management data after cleanup.
"""

Responses:

  • 200: Successful Response

POST /v1/admin/cache/clear-expired

Links: local, eos

Fastapi Admin Cache Clear Expired Post

"""
Clear the cache from expired data.

Deletes expired cache files.

Returns:
    data (dict): The management data after cleanup.
"""

Responses:

  • 200: Successful Response

POST /v1/admin/cache/load

Links: local, eos

Fastapi Admin Cache Load Post

"""
Load cache management data.

Returns:
    data (dict): The management data that was loaded.
"""

Responses:

  • 200: Successful Response

POST /v1/admin/cache/save

Links: local, eos

Fastapi Admin Cache Save Post

"""
Save the current cache management data.

Returns:
    data (dict): The management data that was saved.
"""

Responses:

  • 200: Successful Response

POST /v1/admin/database/save

Links: local, eos

Fastapi Admin Database Save Post

"""
Save in memory data to database.

Returns:
    data (dict): The database stats after saving the records.
"""

Responses:

  • 200: Successful Response

GET /v1/admin/database/stats

Links: local, eos

Fastapi Admin Database Stats Get

"""
Get statistics from database.

Returns:
    data (dict): The database statistics
"""

Responses:

  • 200: Successful Response

POST /v1/admin/database/vacuum

Links: local, eos

Fastapi Admin Database Vacuum Post

"""
Remove old records from database.

Returns:
    data (dict): The database stats after removal of old records.
"""

Responses:

  • 200: Successful Response

POST /v1/admin/server/restart

Links: local, eos

Fastapi Admin Server Restart Post

"""
Restart the server.

Restart EOS properly by starting a new instance before exiting the old one.
"""

Responses:

  • 200: Successful Response

POST /v1/admin/server/shutdown

Links: local, eos

Fastapi Admin Server Shutdown Post

"""
Shutdown the server.
"""

Responses:

  • 200: Successful Response

GET /v1/config

Links: local, eos

Fastapi Config Get

"""
Get the current configuration.

Returns:
    configuration (ConfigEOS): The current configuration.
"""

Responses:

  • 200: Successful Response

PUT /v1/config

Links: local, eos

Fastapi Config Put

"""
Update the current config with the provided settings.

Note that for any setting value that is None or unset, the configuration will fall back to
values from other sources such as environment variables, the EOS configuration file, or default
values.

Args:
    settings (SettingsEOS): The settings to write into the current settings.

Returns:
    configuration (ConfigEOS): The current configuration after the write.
"""

Request Body:

  • application/json: { "$ref": "#/components/schemas/SettingsEOS" }

Responses:

  • 200: Successful Response

  • 422: Validation Error

GET /v1/config/backup

Links: local, eos

Fastapi Config Backup Get

"""
Get the EOS configuration backup identifiers and backup metadata.

Returns:
    dict[str, dict[str, Any]]: Mapping of backup identifiers to metadata.
"""

Responses:

  • 200: Successful Response

PUT /v1/config/file

Links: local, eos

Fastapi Config File Put

"""
Save the current configuration to the EOS configuration file.

Returns:
    configuration (ConfigEOS): The current configuration that was saved.
"""

Responses:

  • 200: Successful Response

POST /v1/config/reset

Links: local, eos

Fastapi Config Reset Post

"""
Reset the configuration to the EOS configuration file.

Returns:
    configuration (ConfigEOS): The current configuration after update.
"""

Responses:

  • 200: Successful Response

PUT /v1/config/revert

Links: local, eos

Fastapi Config Revert Put

"""
Revert the configuration to a EOS configuration backup.

Returns:
    configuration (ConfigEOS): The current configuration after revert.
"""

Parameters:

  • backup_id (query, required): EOS configuration backup ID.

Responses:

  • 200: Successful Response

  • 422: Validation Error

GET /v1/config/{path}

Links: local, eos

Fastapi Config Get Key

"""
Get the value of a nested key or index in the config model.

Args:
    path (str): The nested path to the key (e.g., "general/latitude" or "optimize/nested_list/0").

Returns:
    value (Any): The value of the selected nested key.
"""

Parameters:

  • path (path, required): The nested path to the configuration key (e.g., general/latitude).

Responses:

  • 200: Successful Response

  • 422: Validation Error

PUT /v1/config/{path}

Links: local, eos

Fastapi Config Put Key

"""
Update a nested key or index in the config model.

Args:
    path (str): The nested path to the key (e.g., "general/latitude" or "optimize/nested_list/0").
    value (Any): The new value to assign to the key or index at path.

Returns:
    configuration (ConfigEOS): The current configuration after the update.
"""

Parameters:

  • path (path, required): The nested path to the configuration key (e.g., general/latitude).

Request Body:

  • application/json: { "anyOf": [ {}, { "type": "null" } ], "description": "The value to assign to the specified configuration path (can be None).", "title": "Value" }

Responses:

  • 200: Successful Response

  • 422: Validation Error

GET /v1/energy-management/optimization/solution

Links: local, eos

Fastapi Energy Management Optimization Solution Get

"""
Get the latest solution of the optimization.
"""

Responses:

  • 200: Successful Response

GET /v1/energy-management/plan

Links: local, eos

Fastapi Energy Management Plan Get

"""
Get the latest energy management plan.
"""

Responses:

  • 200: Successful Response

GET /v1/health

Links: local, eos

Fastapi Health Get

"""
Health check endpoint to verify that the EOS server is alive.
"""

Responses:

  • 200: Successful Response

GET /v1/logging/log

Links: local, eos

Fastapi Logging Get Log

"""
Get structured log entries from the EOS log file.

Filters and returns log entries based on the specified query parameters. The log
file is expected to contain newline-delimited JSON entries.

Args:
    limit (int): Maximum number of entries to return.
    level (Optional[str]): Filter logs by severity level (e.g., DEBUG, INFO).
    contains (Optional[str]): Return only logs that include this string in the message.
    regex (Optional[str]): Return logs that match this regular expression in the message.
    from_time (Optional[str]): ISO 8601 timestamp to filter logs not older than this.
    to_time (Optional[str]): ISO 8601 timestamp to filter logs not newer than this.
    tail (bool): If True, fetch the most recent log entries (like `tail`).

Returns:
    JSONResponse: A JSON list of log entries.
"""

Parameters:

  • limit (query, optional): Maximum number of log entries to return.

  • level (query, optional): Filter by log level (e.g., INFO, ERROR).

  • contains (query, optional): Filter logs containing this substring.

  • regex (query, optional): Filter logs by matching regex in message.

  • from_time (query, optional): Start time (ISO format) for filtering logs.

  • to_time (query, optional): End time (ISO format) for filtering logs.

  • tail (query, optional): If True, returns the most recent lines (tail mode).

Responses:

  • 200: Successful Response

  • 422: Validation Error

PUT /v1/measurement/data

Links: local, eos

Fastapi Measurement Data Put

"""
Merge the measurement data given as datetime data into EOS measurements.
"""

Request Body:

  • application/json: { "$ref": "#/components/schemas/PydanticDateTimeData" }

Responses:

  • 200: Successful Response

  • 422: Validation Error

PUT /v1/measurement/dataframe

Links: local, eos

Fastapi Measurement Dataframe Put

"""
Merge the measurement data given as dataframe into EOS measurements.
"""

Request Body:

  • application/json: { "$ref": "#/components/schemas/PydanticDateTimeDataFrame" }

Responses:

  • 200: Successful Response

  • 422: Validation Error

GET /v1/measurement/keys

Links: local, eos

Fastapi Measurement Keys Get

Responses:

  • 200: Successful Response

DELETE /v1/measurement/range

Links: local, eos

Fastapi Measurement Range Delete

"""
Delete measurement values for a key within a datetime range.
"""

Parameters:

  • key (query, required): Measurement key.

  • start_datetime (query, optional): Start datetime.

  • end_datetime (query, optional): End datetime.

Responses:

  • 200: Successful Response

  • 422: Validation Error

GET /v1/measurement/series

Links: local, eos

Fastapi Measurement Series Get

"""
Get the measurements of given key as series.
"""

Parameters:

  • key (query, required): Measurement key.

Responses:

  • 200: Successful Response

  • 422: Validation Error

PUT /v1/measurement/series

Links: local, eos

Fastapi Measurement Series Put

"""
Merge measurement given as series into given key.
"""

Parameters:

  • key (query, required): Measurement key.

Request Body:

  • application/json: { "$ref": "#/components/schemas/PydanticDateTimeSeries" }

Responses:

  • 200: Successful Response

  • 422: Validation Error

PUT /v1/measurement/value

Links: local, eos

Fastapi Measurement Value Put

"""
Merge the measurement of given key and value into EOS measurements at given datetime.
"""

Parameters:

  • datetime (query, required): Datetime.

  • key (query, required): Measurement key.

  • value (query, required): No description provided.

Responses:

  • 200: Successful Response

  • 422: Validation Error

GET /v1/prediction/dataframe

Links: local, eos

Fastapi Prediction Dataframe Get

"""
Get prediction for given key within given date range as series.

Args:
    key (str): Prediction key
    start_datetime (Optional[str]): Starting datetime (inclusive).
        Defaults to start datetime of latest prediction.
    end_datetime (Optional[str]: Ending datetime (exclusive).

Defaults to end datetime of latest prediction.
"""

Parameters:

  • keys (query, required): Prediction keys.

  • start_datetime (query, optional): Starting datetime (inclusive).

  • end_datetime (query, optional): Ending datetime (exclusive).

  • interval (query, optional): Time duration for each interval. Defaults to 1 hour.

Responses:

  • 200: Successful Response

  • 422: Validation Error

PUT /v1/prediction/import/{provider_id}

Links: local, eos

Fastapi Prediction Import Provider

"""
Import prediction for given provider ID.

Args:
    provider_id: ID of provider to update.
    data: Prediction data.
    force_enable: Update data even if provider is disabled.
        Defaults to False.
"""

Parameters:

  • provider_id (path, required): Provider ID.

  • force_enable (query, optional): No description provided.

Request Body:

  • application/json: { "anyOf": [ { "$ref": "#/components/schemas/PydanticDateTimeDataFrame" }, { "$ref": "#/components/schemas/PydanticDateTimeData" }, { "type": "object", "additionalProperties": true }, { "type": "null" } ], "title": "Data" }

Responses:

  • 200: Successful Response

  • 422: Validation Error

GET /v1/prediction/keys

Links: local, eos

Fastapi Prediction Keys Get

"""
Get a list of available prediction keys.
"""

Responses:

  • 200: Successful Response

GET /v1/prediction/list

Links: local, eos

Fastapi Prediction List Get

"""
Get prediction for given key within given date range as value list.

Args:
    key (str): Prediction key
    start_datetime (Optional[str]): Starting datetime (inclusive).
        Defaults to start datetime of latest prediction.
    end_datetime (Optional[str]: Ending datetime (exclusive).
        Defaults to end datetime of latest prediction.
    interval (Optional[str]): Time duration for each interval.
        Defaults to 1 hour.
"""

Parameters:

  • key (query, required): Prediction key.

  • start_datetime (query, optional): Starting datetime (inclusive).

  • end_datetime (query, optional): Ending datetime (exclusive).

  • interval (query, optional): Time duration for each interval. Defaults to 1 hour.

Responses:

  • 200: Successful Response

  • 422: Validation Error

GET /v1/prediction/providers

Links: local, eos

Fastapi Prediction Providers Get

"""
Get a list of available prediction providers.

Args:
    enabled (bool): Return enabled/disabled providers. If unset, return all providers.
"""

Parameters:

  • enabled (query, optional): No description provided.

Responses:

  • 200: Successful Response

  • 422: Validation Error

GET /v1/prediction/series

Links: local, eos

Fastapi Prediction Series Get

"""
Get prediction for given key within given date range as series.

Args:
    key (str): Prediction key
    start_datetime (Optional[str]): Starting datetime (inclusive).
        Defaults to start datetime of latest prediction.
    end_datetime (Optional[str]: Ending datetime (exclusive).
        Defaults to end datetime of latest prediction.
"""

Parameters:

  • key (query, required): Prediction key.

  • start_datetime (query, optional): Starting datetime (inclusive).

  • end_datetime (query, optional): Ending datetime (exclusive).

Responses:

  • 200: Successful Response

  • 422: Validation Error

POST /v1/prediction/update

Links: local, eos

Fastapi Prediction Update

"""
Update predictions for all providers.

Args:
    force_update: Update data even if it is already cached.
        Defaults to False.
    force_enable: Update data even if provider is disabled.
        Defaults to False.
"""

Parameters:

  • force_update (query, optional): No description provided.

  • force_enable (query, optional): No description provided.

Responses:

  • 200: Successful Response

  • 422: Validation Error

POST /v1/prediction/update/{provider_id}

Links: local, eos

Fastapi Prediction Update Provider

"""
Update predictions for given provider ID.

Args:
    provider_id: ID of provider to update.
    force_update: Update data even if it is already cached.
        Defaults to False.
    force_enable: Update data even if provider is disabled.
        Defaults to False.
"""

Parameters:

  • provider_id (path, required): No description provided.

  • force_update (query, optional): No description provided.

  • force_enable (query, optional): No description provided.

Responses:

  • 200: Successful Response

  • 422: Validation Error

GET /v1/resource/status

Links: local, eos

Fastapi Devices Status Get

"""
Get the latest status of a resource/ device.

Return:
    latest_status: The latest status of a resource/ device.
"""

Parameters:

  • resource_id (query, required): Resource ID.

  • actuator_id (query, optional): Actuator ID.

Responses:

  • 200: Successful Response

  • 422: Validation Error

PUT /v1/resource/status

Links: local, eos

Fastapi Devices Status Put

"""
Update the status of a resource/ device.

Return:
    latest_status: The latest status of a resource/ device.
"""

Parameters:

  • resource_id (query, required): Resource ID.

  • actuator_id (query, optional): Actuator ID.

Request Body:

  • application/json: { "anyOf": [ { "$ref": "#/components/schemas/PowerMeasurement" }, { "$ref": "#/components/schemas/EnergyMeasurement" }, { "$ref": "#/components/schemas/PPBCPowerProfileStatus" }, { "$ref": "#/components/schemas/OMBCStatus" }, { "$ref": "#/components/schemas/FRBCActuatorStatus" }, { "$ref": "#/components/schemas/FRBCEnergyStatus" }, { "$ref": "#/components/schemas/FRBCStorageStatus" }, { "$ref": "#/components/schemas/FRBCTimerStatus" }, { "$ref": "#/components/schemas/DDBCActuatorStatus" } ], "description": "Resource Status.", "title": "Status" }

Responses:

  • 200: Successful Response

  • 422: Validation Error

GET /visualization_results.pdf

Links: local, eos

Get Pdf

Responses:

  • 200: Successful Response

Auto generated from openapi.json.