Bobby NoelteandClaude Opus 5.5
faf37abfe7
An inverter profile describes the technical data of an inverter model: its nominal AC power, the DC→AC and AC→DC efficiency curves over the load fraction (AC power relative to the nominal power), the AC charge power limit of the model, whether that limit also limits PV charging, and an optional power derating over the ambient temperature. Curves are read linearly and clamped at their ends, so every lookup yields a value. The packaged profile generic-hybrid has typical hybrid inverter efficiencies, no nominal power (the inverter device has to provide it) and full power up to 45 degC. Inverter settings name their profile (inverter_profile, default generic-hybrid) and hold the differences of the unit in profile_adjustment: nominal_power_w (replaces the profile value, required for a generic profile), max_power_w and max_ac_charge_power_w (installation limits that can only lower; an AC charge limit of 0 disables AC charging). The effective parameters are resolved at the ambient temperature of the inverter, given by the new measurement key <device_id>-temperature-degc (45 degC without a fresh value); the power derating lowers the maximum power and the AC charge limit. Optimization parameters are always valid: the GENETIC and GENETIC0 parameter preparation resolve the inverter with resolve_current_operating_parameters_or_defaults, which never raises. An unusable profile gives the generic-hybrid profile, a missing nominal power the fallback of 10000 W, an inverter derated to zero power the parameters at 45 degC, and no usable profile at all the profile adjustment with constant efficiency; each is logged as error. The GENETIC inverter takes the AC→DC efficiency curve of the profile, solved exactly on each linear piece of the curve (about 2 % longer runs); GENETIC0 keeps constant efficiencies and no longer replaces the configured inverters with the demo inverter; a battery, electric vehicle or inverter that cannot be prepared is left out of the GENETIC0 run, never replaced by a demo device. Configurations migrate: max_power_w becomes profile_adjustment.nominal_power_w, max_ac_charge_power_w moves into the adjustment, an ac_to_dc_efficiency of 0 keeps AC charging disabled, and the efficiency fields are dropped with an error log, as for batteries, so the profile efficiencies apply. Home Assistant config paths follow. Additional changes - Move the curve algorithms of the battery profile into profilecurve, so battery and inverter profiles share them; the battery profile keeps its document format and classes. - Move ProfileBaseModel, the strict base of profile documents, into profilestore. - Serve inverter profiles through the profile REST API. Refuse to delete a profile that a configured device uses and that has no packaged profile to revert to (409). - Share the measurement access of the device settings in devicemeasurement. - Rename check_battery_profiles to check_device_profiles; the device profile check at configuration setup covers inverters, too. - Document inverter profiles, their configuration, defaults and sharing; regenerate the configuration and OpenAPI documentation. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Assisted-by: Claude Code (claude-opus-5-5)
71 KiB
Akkudoktor-EOS
Version: v0.3.0.dev2611111434732824
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.
Currency Information
All monetary values in this API are expressed in the locally configured currency of the EOS installation. The system is designed to work with any currency (e.g., EUR, SEK, CHF, USD, GBP, etc.). Each installation uses a single, consistent currency throughout all endpoints and responses.
Values are given in whole currency units, not in hundredth subunits: a value of 0.0003 in an installation configured for Euro means 0.0003 EUR/Wh (i.e. 0.30 EUR/kWh), never cents. The same applies to all totals (e.g. total_costs of 1.5 = 1.50 EUR).
Field names containing cost, price, revenue, tariff, or similar monetary terms (e.g., total_costs, electricity_price_per_wh, revenue_per_hour) represent amounts in the configured currency, without explicit currency designation in the field name to maintain currency-neutrality.
Deprecated Field Names
The genetic optimization API fields were renamed from German to English. For backward compatibility the old German field names (e.g. gesamtlast, pv_prognose_wh, Gesamtbilanz_Euro) are still accepted on input and are emitted in responses alongside the English names, marked as deprecated in the schema. They will be removed in a future release — new clients should use the English field names only.
Base URL: No base URL provided.
Endpoints:
POST /gesamtlast
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
in 1-hour intervals. 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
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
in 1-hour intervals. 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
Fastapi Optimize
"""
Deprecated: Optimize.
Endpoint to handle optimization.
Uses the `classic` GENETIC0 optimisation algorithm (__NO__ 15-minutes slots).
Note:
Use automatic optimization instead.
"v1/energy-management/optimization/solution/GENETIC0"
"""
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/Genetic0OptimizationParameters-Input" }
Responses:
-
200: Successful Response
-
422: Validation Error
GET /pvforecast
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
in 1-hour intervals. 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
Fastapi Strompreis
"""
Deprecated: Electricity Market Price Prediction per Wh [amount/Wh].
Electricity prices start at 00.00.00 today and are provided for 48 hours
in 1-hour intervals. 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
Fastapi Admin Cache Get
"""
Current cache management data.
Returns:
data (dict): The management data.
"""
Responses:
- 200: Successful Response
POST /v1/admin/cache/clear
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
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
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
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
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
Fastapi Admin Database Stats Get
"""
Get statistics from database.
Returns:
data (dict): The database statistics
"""
Responses:
- 200: Successful Response
POST /v1/admin/database/vacuum
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
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
Fastapi Admin Server Shutdown Post
"""
Shutdown the server.
"""
Responses:
- 200: Successful Response
GET /v1/config
Fastapi Config Get
"""
Get the current configuration.
Returns:
configuration (ConfigEOS): The current configuration.
"""
Responses:
- 200: Successful Response
PUT /v1/config
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
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
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
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
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}
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}
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
Fastapi Energy Management Optimization Solution Get
"""
Get the latest solution of the optimization.
"""
Responses:
- 200: Successful Response
GET /v1/energy-management/optimization/solution/GENETIC/pdf
Fastapi Energy Management Optimization Solution Genetic Pdf Get
"""
Render the retained GENETIC result without rerunning optimization.
Rendering runs outside the event loop. Copy the result before offloading;
its recorded timestamp, interval and inputs own the report's time grid.
The legacy /visualization_results.pdf route continues to serve GENETIC0.
"""
Responses:
- 200: Successful Response
GET /v1/energy-management/optimization/solution/{algorithm}
Fastapi Energy Management Optimization Solution Algorithm Get
"""
Get the latest algorithm specific solution of the optimization.
Args:
algorithm: Optimization algorithm
"""
Parameters:
algorithm(path, required): No description provided.
Responses:
-
200: Successful Response
-
422: Validation Error
GET /v1/energy-management/plan
Fastapi Energy Management Plan Get
"""
Get the latest energy management plan.
"""
Responses:
- 200: Successful Response
GET /v1/health
Fastapi Health Get
"""
Health check endpoint to verify that the EOS server is alive.
"""
Responses:
- 200: Successful Response
GET /v1/logging/log
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
POST /v1/measurement/battery-capacity/{battery_id}
Post Battery Capacity
"""
Estimate capacity from independent SoC anchors and configured DC power.
store_estimate writes the separate capacity_estimate config field in memory.
Persistence follows the regular EOS configuration save mechanism.
The active capacity_wh and raw measurements are never changed here.
"""
Parameters:
battery_id(path, required): No description provided.
Request Body:
application/json: { "$ref": "#/components/schemas/BatteryCapacityRequest" }
Responses:
-
200: Successful Response
-
422: Validation Error
PUT /v1/measurement/data
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
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/energy
Get Energy
"""
Energy in Wh, with temporal coverage and quality; no missing-to-zero filling.
"""
Parameters:
-
key(query, required): No description provided. -
start(query, required): No description provided. -
end(query, required): No description provided. -
interval_seconds(query, optional): No description provided.
Responses:
-
200: Successful Response
-
422: Validation Error
GET /v1/measurement/household
Get Household
"""
Site, household without EV, and base without separately measured devices.
"""
Parameters:
-
start(query, required): No description provided. -
end(query, required): No description provided. -
interval_seconds(query, optional): No description provided.
Responses:
-
200: Successful Response
-
422: Validation Error
GET /v1/measurement/keys
Fastapi Measurement Keys Get
"""
Get a list of available measurement keys.
"""
Responses:
- 200: Successful Response
DELETE /v1/measurement/range
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/samples
Get Samples
"""
Read raw samples including quality, in a bounded half-open range.
"""
Parameters:
-
key(query, required): No description provided. -
start(query, required): No description provided. -
end(query, required): No description provided.
Responses:
-
200: Successful Response
-
422: Validation Error
PUT /v1/measurement/samples
Put Samples
"""
Upsert raw values and their quality; legacy value/series payloads remain valid.
"""
Request Body:
application/json: { "type": "array", "items": { "$ref": "#/components/schemas/MeasurementSample" }, "maxItems": 10000, "title": "Samples" }
Responses:
-
200: Successful Response
-
422: Validation Error
GET /v1/measurement/series
Fastapi Measurement Series Get
"""
Get measurements for given key within given date range as series.
Args:
key (str): Measurement key
start_datetime (Optional[str]): Starting datetime (inclusive).
Defaults to datetime of first measurement.
end_datetime (Optional[str]: Ending datetime (exclusive).
Defaults to datetime after latest measurement.
interval (Optional[str]): Time duration for each interval.
Defaults to 1 hour.
fill_method (str): Method to handle missing values during resampling.
- 'linear': Linearly interpolate missing values (for numeric data only).
- 'time': Interpolate missing values (for numeric data only).
- 'ffill': Forward fill missing values.
- 'bfill': Backward fill missing values.
- Defaults to 'linear' for numeric values, otherwise 'ffill'.
resample_method (str):
Method used to aggregate values within a resampling interval.
- "first": Use the first value in each interval.
- "mean": Compute the arithmetic mean of all samples in each interval.
- "interval_mean": Compute the time-weighted mean assuming each
value remains valid until the next timestamp (piecewise-constant
signal).
dropna: (bool): Whether to drop NAN/ None values before processing.
Defaults to True.
boundary (Literal["strict", "context"]): resampling boundary
"strict" → only values inside [start, end)
"context" → include one value before and after for proper resampling
align_to_interval (bool): When True, snap the resample origin to the nearest
UTC epoch-aligned boundary of ``interval`` before resampling. This ensures
that bucket timestamps always fall on wall-clock-round times regardless of
when ``start_datetime`` falls:
- 15-minute interval → buckets on :00, :15, :30, :45
- 1-hour interval → buckets on the hour
When False (default), the origin is ``query_start`` (or ``"start_day"`` when
no start is given), preserving the existing behaviour where buckets are
aligned to the query window rather than the clock.
Set to True when storing compacted records back to the database so that the
resulting timestamps are predictable and human-readable. Leave False for
forecast or reporting queries where alignment to the exact query window is
more important than clock-round boundaries.
processing (SeriesProcessing):
Processing mode for the returned series.
- ``SeriesProcessing.RESAMPLED``: Return a processed series.
Measurements are first filtered by ``start_datetime``,
``end_datetime``, and ``dropna``, then resampled according to
``interval`` and ``resample_method``, and finally missing values
are filled using ``fill_method``.
- ``SeriesProcessing.RAW``: Return the original measurement series.
Measurements are filtered by ``start_datetime``,
``end_datetime``, and ``dropna`` only. No resampling or filling is
performed, and ``interval``, ``fill_method``,
``resample_method``, ``boundary``, and
``align_to_interval`` are ignored.
Defaults to ``SeriesProcessing.RAW``.
Returns:
Series
"""
Parameters:
-
key(query, required): Measurement 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. -
fill_method(query, optional): Method to handle missing values during resampling. -
resample_method(query, optional): Method used to aggregate values within a resampling interval. -
dropna(query, optional): Drop NAN/ None values before processing. -
boundary(query, optional): Resampling boundary mode. -
align_to_interval(query, optional): Snap resample origin to the nearest UTC epoch-aligned boundary of interval. -
processing(query, optional): Processing mode. 'raw' returns original measurement data without resampling or filling.
Responses:
-
200: Successful Response
-
422: Validation Error
PUT /v1/measurement/series
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
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
POST /v1/optimize
Fastapi Optimize Config
"""
Optimize GENETIC using configured devices and optional fresh runtime inputs.
Static settings belong in configuration; query overrides are rejected.
Forecast arrays start at local
midnight and contain Wh per configured GENETIC slot; prices are currency/Wh.
An empty body uses configured providers. Explicit SoC values take precedence over
fresh measured states of charge; missing usable measurements default to an assumed
initial SoC of 0% without blocking a plan.
The deprecated /optimize endpoint continues to run hourly GENETIC0.
"""
Request Body:
application/json: { "$ref": "#/components/schemas/ConfigOptimizationRequest" }
Responses:
-
200: Successful Response
-
422: Validation Error
GET /v1/prediction/dataframe
Fastapi Prediction Dataframe Get
"""
Get prediction for given keys within given date range as dataframe.
Args:
key (list[str]): Prediction keys
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.
fill_method (str): Method to handle missing values during resampling.
- 'linear': Linearly interpolate missing values (for numeric data only).
- 'time': Interpolate missing values (for numeric data only).
- 'ffill': Forward fill missing values.
- 'bfill': Backward fill missing values.
- Defaults to 'linear' for numeric values, otherwise 'ffill'.
resample_method (str):
Method used to aggregate values within a resampling interval.
- "first": Use the first value in each interval.
- "mean": Compute the arithmetic mean of all samples in each interval.
- "interval_mean": Compute the time-weighted mean assuming each
value remains valid until the next timestamp (piecewise-constant
signal).
dropna: (bool): Whether to drop NAN/ None values before processing.
Defaults to True.
boundary (Literal["strict", "context"]): resampling boundary
"strict" → only values inside [start, end)
"context" → include one value before and after for proper resampling
align_to_interval (bool): When True, snap the resample origin to the nearest
UTC epoch-aligned boundary of ``interval`` before resampling. This ensures
that bucket timestamps always fall on wall-clock-round times regardless of
when ``start_datetime`` falls:
- 15-minute interval → buckets on :00, :15, :30, :45
- 1-hour interval → buckets on the hour
When False (default), the origin is ``query_start`` (or ``"start_day"`` when
no start is given), preserving the existing behaviour where buckets are
aligned to the query window rather than the clock.
Set to True when storing compacted records back to the database so that the
resulting timestamps are predictable and human-readable. Leave False for
forecast or reporting queries where alignment to the exact query window is
more important than clock-round boundaries.
"""
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. -
fill_method(query, optional): Method to handle missing values during resampling. -
resample_method(query, optional): Method used to aggregate values within a resampling interval. -
dropna(query, optional): Drop NAN/ None values before processing. -
boundary(query, optional): Resampling boundary mode. -
align_to_interval(query, optional): Snap resample origin to the nearest UTC epoch-aligned boundary of interval.
Responses:
-
200: Successful Response
-
422: Validation Error
PUT /v1/prediction/import/{provider_id}
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
Fastapi Prediction Keys Get
"""
Get a list of available prediction keys.
"""
Responses:
- 200: Successful Response
GET /v1/prediction/list
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.
fill_method (str): Method to handle missing values during resampling.
- 'linear': Linearly interpolate missing values (for numeric data only).
- 'time': Interpolate missing values (for numeric data only).
- 'ffill': Forward fill missing values.
- 'bfill': Backward fill missing values.
- Defaults to 'linear' for numeric values, otherwise 'ffill'.
resample_method (str):
Method used to aggregate values within a resampling interval.
- "first": Use the first value in each interval.
- "mean": Compute the arithmetic mean of all samples in each interval.
- "interval_mean": Compute the time-weighted mean assuming each
value remains valid until the next timestamp (piecewise-constant
signal).
dropna: (bool): Whether to drop NAN/ None values before processing.
Defaults to True.
boundary (Literal["strict", "context"]): resampling boundary
"strict" → only values inside [start, end)
"context" → include one value before and after for proper resampling
align_to_interval (bool): When True, snap the resample origin to the nearest
UTC epoch-aligned boundary of ``interval`` before resampling. This ensures
that bucket timestamps always fall on wall-clock-round times regardless of
when ``start_datetime`` falls:
- 15-minute interval → buckets on :00, :15, :30, :45
- 1-hour interval → buckets on the hour
When False (default), the origin is ``query_start`` (or ``"start_day"`` when
no start is given), preserving the existing behaviour where buckets are
aligned to the query window rather than the clock.
Set to True when storing compacted records back to the database so that the
resulting timestamps are predictable and human-readable. Leave False for
forecast or reporting queries where alignment to the exact query window is
more important than clock-round boundaries.
"""
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. -
fill_method(query, optional): Method to handle missing values during resampling. -
resample_method(query, optional): Method used to aggregate values within a resampling interval. -
dropna(query, optional): Drop NAN/ None values before processing. -
boundary(query, optional): Resampling boundary mode. -
align_to_interval(query, optional): Snap resample origin to the nearest UTC epoch-aligned boundary of interval.
Responses:
-
200: Successful Response
-
422: Validation Error
GET /v1/prediction/providers
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/pv-adaptive/comparisons
Comparisons
"""
Export genuinely issued forecasts with later measured truth, issuance and lead.
"""
Parameters:
-
days(query, optional): No description provided. -
limit(query, optional): No description provided. -
since_ms(query, optional): No description provided.
Responses:
-
200: Successful Response
-
422: Validation Error
GET /v1/prediction/pv-adaptive/latest
Latest
"""
Latest complete output curve; validation uses the separate immutable archive.
"""
Responses:
- 200: Successful Response
PUT /v1/prediction/pv-adaptive/samples
Samples
"""
Store original power readings in the bounded adaptive archive, without zero filling.
"""
Request Body:
application/json: { "items": { "$ref": "#/components/schemas/MeasurementSample" }, "type": "array", "maxItems": 10000, "title": "Values" }
Responses:
-
200: Successful Response
-
422: Validation Error
GET /v1/prediction/pv-adaptive/status
Status
"""
Status contains honest cold-start counts and matched per-lead error metrics.
"""
Responses:
- 200: Successful Response
GET /v1/prediction/pvforecast/pvlib/inverters
Fastapi Prediction Pvforecast Inverters Get
"""
Get inverter names supported by PVForecast PVLib provider.
"""
Responses:
- 200: Successful Response
GET /v1/prediction/pvforecast/pvlib/modules
Fastapi Prediction Pvforecast Modules Get
"""
Get module names supported by PVForecast PVLib provider.
"""
Responses:
- 200: Successful Response
DELETE /v1/prediction/range
Fastapi Prediction Range Delete
"""
Delete prediction values for a key within a datetime range.
"""
Parameters:
-
key(query, required): Prediction key. -
start_datetime(query, optional): Start datetime. -
end_datetime(query, optional): End datetime.
Responses:
-
200: Successful Response
-
422: Validation Error
GET /v1/prediction/series
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.
interval (Optional[str]): Time duration for each interval.
Defaults to 1 hour.
fill_method (str): Method to handle missing values during resampling.
- 'linear': Linearly interpolate missing values (for numeric data only).
- 'time': Interpolate missing values (for numeric data only).
- 'ffill': Forward fill missing values.
- 'bfill': Backward fill missing values.
- Defaults to 'linear' for numeric values, otherwise 'ffill'.
resample_method (str):
Method used to aggregate values within a resampling interval.
- "first": Use the first value in each interval.
- "mean": Compute the arithmetic mean of all samples in each interval.
- "interval_mean": Compute the time-weighted mean assuming each
value remains valid until the next timestamp (piecewise-constant
signal).
dropna: (bool): Whether to drop NAN/ None values before processing.
Defaults to True.
boundary (Literal["strict", "context"]): resampling boundary
"strict" → only values inside [start, end)
"context" → include one value before and after for proper resampling
align_to_interval (bool): When True, snap the resample origin to the nearest
UTC epoch-aligned boundary of ``interval`` before resampling. This ensures
that bucket timestamps always fall on wall-clock-round times regardless of
when ``start_datetime`` falls:
- 15-minute interval → buckets on :00, :15, :30, :45
- 1-hour interval → buckets on the hour
When False (default), the origin is ``query_start`` (or ``"start_day"`` when
no start is given), preserving the existing behaviour where buckets are
aligned to the query window rather than the clock.
Set to True when storing compacted records back to the database so that the
resulting timestamps are predictable and human-readable. Leave False for
forecast or reporting queries where alignment to the exact query window is
more important than clock-round boundaries.
processing (SeriesProcessing):
Processing mode for the returned series.
- ``SeriesProcessing.RESAMPLED``: Return a processed series.
Measurements are first filtered by ``start_datetime``,
``end_datetime``, and ``dropna``, then resampled according to
``interval`` and ``resample_method``, and finally missing values
are filled using ``fill_method``.
- ``SeriesProcessing.RAW``: Return the original measurement series.
Measurements are filtered by ``start_datetime``,
``end_datetime``, and ``dropna`` only. No resampling or filling is
performed, and ``interval``, ``fill_method``,
``resample_method``, ``boundary``, and
``align_to_interval`` are ignored.
Defaults to ``SeriesProcessing.RAW``.
Returns:
Array
"""
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. -
fill_method(query, optional): Method to handle missing values during resampling. -
resample_method(query, optional): Method used to aggregate values within a resampling interval. -
dropna(query, optional): Drop NAN/ None values before processing. -
boundary(query, optional): Resampling boundary mode. -
align_to_interval(query, optional): Snap resample origin to the nearest UTC epoch-aligned boundary of interval. -
processing(query, optional): Processing mode. 'raw' returns original measurement data without resampling or filling.
Responses:
-
200: Successful Response
-
422: Validation Error
POST /v1/prediction/update
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}
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/profile
Get Profile Kinds
"""
Return the registered profile kinds.
"""
Responses:
- 200: Successful Response
GET /v1/profile/{kind}
Get Profiles
"""
Return the profiles of a kind, from the user and the packaged data directory.
"""
Parameters:
kind(path, required): Profile kind, e.g. 'battery'.
Responses:
-
200: Successful Response
-
422: Validation Error
GET /v1/profile/{kind}/schema
Get Profile Schema
"""
Return the JSON schema of the profile documents of a kind.
"""
Parameters:
kind(path, required): Profile kind, e.g. 'battery'.
Responses:
-
200: Successful Response
-
422: Validation Error
DELETE /v1/profile/{kind}/{name}
Delete Profile
"""
Delete a user profile.
Returns the profile that applies now (the packaged one of the same name),
or null if there is none. A profile that a configured device uses can only
be deleted if a packaged profile of the same name applies afterwards.
"""
Parameters:
-
kind(path, required): Profile kind, e.g. 'battery'. -
name(path, required): Profile name without '.json', e.g. 'generic-lfp' (letters, digits, '.', '_', '-').
Responses:
-
200: Successful Response
-
422: Validation Error
GET /v1/profile/{kind}/{name}
Get Profile
"""
Return the document of a profile (user profile first, then packaged).
"""
Parameters:
-
kind(path, required): Profile kind, e.g. 'battery'. -
name(path, required): Profile name without '.json', e.g. 'generic-lfp' (letters, digits, '.', '_', '-').
Responses:
-
200: Successful Response
-
422: Validation Error
PUT /v1/profile/{kind}/{name}
Put Profile
"""
Validate a profile document and save it to the user data directory.
Returns the saved (validated, defaults filled in) document.
"""
Parameters:
-
kind(path, required): Profile kind, e.g. 'battery'. -
name(path, required): Profile name without '.json', e.g. 'generic-lfp' (letters, digits, '.', '_', '-').
Request Body:
application/json: { "type": "object", "additionalProperties": true, "description": "The profile document.", "title": "Document" }
Responses:
-
200: Successful Response
-
422: Validation Error
GET /v1/resource/status
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
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: { "oneOf": [ { "$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" } ], "discriminator": { "propertyName": "type", "mapping": { "PowerMeasurement": "#/components/schemas/PowerMeasurement", "EnergyMeasurement": "#/components/schemas/EnergyMeasurement", "PPBCPowerProfileStatus": "#/components/schemas/PPBCPowerProfileStatus", "OMBCStatus": "#/components/schemas/OMBCStatus", "FRBCActuatorStatus": "#/components/schemas/FRBCActuatorStatus", "FRBCEnergyStatus": "#/components/schemas/FRBCEnergyStatus", "FRBCStorageStatus": "#/components/schemas/FRBCStorageStatus", "FRBCTimerStatus": "#/components/schemas/FRBCTimerStatus", "DDBCActuatorStatus": "#/components/schemas/DDBCActuatorStatus" } }, "description": "Resource Status.", "title": "Status" }
Responses:
-
200: Successful Response
-
422: Validation Error
GET /visualization_results.pdf
Get Pdf
Responses:
- 200: Successful Response
Auto generated from openapi.json.