mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2025-10-29 05:46:20 +00:00
b397b5d43e
This fix implements the long term goal to have the EOS server run optimization (or
energy management) on regular intervals automatically. Thus clients can request
the current energy management plan at any time and it is updated on regular
intervals without interaction by the client.
This fix started out to "only" make automatic optimization (or energy management)
runs working. It turned out there are several endpoints that in some way
update predictions or run the optimization. To lock against such concurrent attempts
the code had to be refactored to allow control of execution. During refactoring it
became clear that some classes and files are named without a proper reference
to their usage. Thus not only refactoring but also renaming became necessary.
The names are still not the best, but I hope they are more intuitive.
The fix includes several bug fixes that are not directly related to the automatic optimization
but are necessary to keep EOS running properly to do the automatic optimization and
to test and document the changes.
This is a breaking change as the configuration structure changed once again and
the server API was also enhanced and streamlined. The server API that is used by
Andreas and Jörg in their videos has not changed.
* fix: automatic optimization
Allow optimization to automatically run on configured intervals gathering all
optimization parameters from configuration and predictions. The automatic run
can be configured to only run prediction updates skipping the optimization.
Extend documentaion to also cover automatic optimization. Lock automatic runs
against runs initiated by the /optimize or other endpoints. Provide new
endpoints to retrieve the energy management plan and the genetic solution
of the latest automatic optimization run. Offload energy management to thread
pool executor to keep the app more responsive during the CPU heavy optimization
run.
* fix: EOS servers recognize environment variables on startup
Force initialisation of EOS configuration on server startup to assure
all sources of EOS configuration are properly set up and read. Adapt
server tests and configuration tests to also test for environment
variable configuration.
* fix: Remove 0.0.0.0 to localhost translation under Windows
EOS imposed a 0.0.0.0 to localhost translation under Windows for
convenience. This caused some trouble in user configurations. Now, as the
default IP address configuration is 127.0.0.1, the user is responsible
for to set up the correct Windows compliant IP address.
* fix: allow names for hosts additional to IP addresses
* fix: access pydantic model fields by class
Access by instance is deprecated.
* fix: down sampling key_to_array
* fix: make cache clear endpoint clear all cache files
Make /v1/admin/cache/clear clear all cache files. Before it only cleared
expired cache files by default. Add new endpoint /v1/admin/clear-expired
to only clear expired cache files.
* fix: timezonefinder returns Europe/Paris instead of Europe/Berlin
timezonefinder 8.10 got more inaccurate for timezones in europe as there is
a common timezone. Use new package tzfpy instead which is still returning
Europe/Berlin if you are in Germany. tzfpy also claims to be faster than
timezonefinder.
* fix: provider settings configuration
Provider configuration used to be a union holding the settings for several
providers. Pydantic union handling does not always find the correct type
for a provider setting. This led to exceptions in specific configurations.
Now provider settings are explicit comfiguration items for each possible
provider. This is a breaking change as the configuration structure was
changed.
* fix: ClearOutside weather prediction irradiance calculation
Pvlib needs a pandas time index. Convert time index.
* fix: test config file priority
Do not use config_eos fixture as this fixture already creates a config file.
* fix: optimization sample request documentation
Provide all data in documentation of optimization sample request.
* fix: gitlint blocking pip dependency resolution
Replace gitlint by commitizen. Gitlint is not actively maintained anymore.
Gitlint dependencies blocked pip from dependency resolution.
* fix: sync pre-commit config to actual dependency requirements
.pre-commit-config.yaml was out of sync, also requirements-dev.txt.
* fix: missing babel in requirements.txt
Add babel to requirements.txt
* feat: setup default device configuration for automatic optimization
In case the parameters for automatic optimization are not fully defined a
default configuration is setup to allow the automatic energy management
run. The default configuration may help the user to correctly define
the device configuration.
* feat: allow configuration of genetic algorithm parameters
The genetic algorithm parameters for number of individuals, number of
generations, the seed and penalty function parameters are now avaliable
as configuration options.
* feat: allow configuration of home appliance time windows
The time windows a home appliance is allowed to run are now configurable
by the configuration (for /v1 API) and also by the home appliance parameters
(for the classic /optimize API). If there is no such configuration the
time window defaults to optimization hours, which was the standard before
the change. Documentation on how to configure time windows is added.
* feat: standardize mesaurement keys for battery/ ev SoC measurements
The standardized measurement keys to report battery SoC to the device
simulations can now be retrieved from the device configuration as a
read-only config option.
* feat: feed in tariff prediction
Add feed in tarif predictions needed for automatic optimization. The feed in
tariff can be retrieved as fixed feed in tarif or can be imported. Also add
tests for the different feed in tariff providers. Extend documentation to
cover the feed in tariff providers.
* feat: add energy management plan based on S2 standard instructions
EOS can generate an energy management plan as a list of simple instructions.
May be retrieved by the /v1/energy-management/plan endpoint. The instructions
loosely follow the S2 energy management standard.
* feat: make measurement keys configurable by EOS configuration.
The fixed measurement keys are replaced by configurable measurement keys.
* feat: make pendulum DateTime, Date, Duration types usable for pydantic models
Use pydantic_extra_types.pendulum_dt to get pydantic pendulum types. Types are
added to the datetimeutil utility. Remove custom made pendulum adaptations
from EOS pydantic module. Make EOS modules use the pydantic pendulum types
managed by the datetimeutil module instead of the core pendulum types.
* feat: Add Time, TimeWindow, TimeWindowSequence and to_time to datetimeutil.
The time windows are are added to support home appliance time window
configuration. All time classes are also pydantic models. Time is the base
class for time definition derived from pendulum.Time.
* feat: Extend DataRecord by configurable field like data.
Configurable field like data was added to support the configuration of
measurement records.
* feat: Add additional information to health information
Version information is added to the health endpoints of eos and eosDash.
The start time of the last optimization and the latest run time of the energy
management is added to the EOS health information.
* feat: add pydantic merge model tests
* feat: add plan tab to EOSdash
The plan tab displays the current energy management instructions.
* feat: add predictions tab to EOSdash
The predictions tab displays the current predictions.
* feat: add cache management to EOSdash admin tab
The admin tab is extended by a section for cache management. It allows to
clear the cache.
* feat: add about tab to EOSdash
The about tab resembles the former hello tab and provides extra information.
* feat: Adapt changelog and prepare for release management
Release management using commitizen is added. The changelog file is adapted and
teh changelog and a description for release management is added in the
documentation.
* feat(doc): Improve install and devlopment documentation
Provide a more concise installation description in Readme.md and add extra
installation page and development page to documentation.
* chore: Use memory cache for interpolation instead of dict in inverter
Decorate calculate_self_consumption() with @cachemethod_until_update to cache
results in memory during an energy management/ optimization run. Replacement
of dict type caching in inverter is now possible because all optimization
runs are properly locked and the memory cache CacheUntilUpdateStore is properly
cleared at the start of any energy management/ optimization operation.
* chore: refactor genetic
Refactor the genetic algorithm modules for enhanced module structure and better
readability. Removed unnecessary and overcomplex devices singleton. Also
split devices configuration from genetic algorithm parameters to allow further
development independently from genetic algorithm parameter format. Move
charge rates configuration for electric vehicles from optimization to devices
configuration to allow to have different charge rates for different cars in
the future.
* chore: Rename memory cache to CacheEnergyManagementStore
The name better resembles the task of the cache to chache function and method
results for an energy management run. Also the decorator functions are renamed
accordingly: cachemethod_energy_management, cache_energy_management
* chore: use class properties for config/ems/prediction mixin classes
* chore: skip debug logs from mathplotlib
Mathplotlib is very noisy in debug mode.
* chore: automatically sync bokeh js to bokeh python package
bokeh was updated to 3.8.0, make JS CDN automatically follow the package version.
* chore: rename hello.py to about.py
Make hello.py the adapted EOSdash about page.
* chore: remove demo page from EOSdash
As no the plan and prediction pages are working without configuration, the demo
page is no longer necessary
* chore: split test_server.py for system test
Split test_server.py to create explicit test_system.py for system tests.
* chore: move doc utils to generate_config_md.py
The doc utils are only used in scripts/generate_config_md.py. Move it there to
attribute for strong cohesion.
* chore: improve pydantic merge model documentation
* chore: remove pendulum warning from readme
* chore: remove GitHub discussions from contributing documentation
Github discussions is to be replaced by Akkudoktor.net.
* chore(release): bump version to 0.1.0+dev for development
* build(deps): bump fastapi[standard] from 0.115.14 to 0.117.1
bump fastapi and make coverage version (for pytest-cov) explicit to avoid pip break.
* build(deps): bump uvicorn from 0.36.0 to 0.37.0
BREAKING CHANGE: EOS configuration changed. V1 API changed.
- The available_charge_rates_percent configuration is removed from optimization.
Use the new charge_rate configuration for the electric vehicle
- Optimization configuration parameter hours renamed to horizon_hours
- Device configuration now has to provide the number of devices and device
properties per device.
- Specific prediction provider configuration to be provided by explicit
configuration item (no union for all providers).
- Measurement keys to be provided as a list.
- New feed in tariff providers have to be configured.
- /v1/measurement/loadxxx endpoints are removed. Use generic mesaurement endpoints.
- /v1/admin/cache/clear now clears all cache files. Use
/v1/admin/cache/clear-expired to only clear all expired cache files.
Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
7804 lines
247 KiB
JSON
7804 lines
247 KiB
JSON
{
|
|
"openapi": "3.1.0",
|
|
"info": {
|
|
"title": "Akkudoktor-EOS",
|
|
"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.",
|
|
"version": "v0.1.0+dev"
|
|
},
|
|
"paths": {
|
|
"/v1/admin/cache/clear": {
|
|
"post": {
|
|
"tags": [
|
|
"admin"
|
|
],
|
|
"summary": "Fastapi Admin Cache Clear Post",
|
|
"description": "Clear the cache.\n\nDeletes all cache files.\n\nReturns:\n data (dict): The management data after cleanup.",
|
|
"operationId": "fastapi_admin_cache_clear_post_v1_admin_cache_clear_post",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Response Fastapi Admin Cache Clear Post V1 Admin Cache Clear Post"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/admin/cache/clear-expired": {
|
|
"post": {
|
|
"tags": [
|
|
"admin"
|
|
],
|
|
"summary": "Fastapi Admin Cache Clear Expired Post",
|
|
"description": "Clear the cache from expired data.\n\nDeletes expired cache files.\n\nReturns:\n data (dict): The management data after cleanup.",
|
|
"operationId": "fastapi_admin_cache_clear_expired_post_v1_admin_cache_clear_expired_post",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Response Fastapi Admin Cache Clear Expired Post V1 Admin Cache Clear Expired Post"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/admin/cache/save": {
|
|
"post": {
|
|
"tags": [
|
|
"admin"
|
|
],
|
|
"summary": "Fastapi Admin Cache Save Post",
|
|
"description": "Save the current cache management data.\n\nReturns:\n data (dict): The management data that was saved.",
|
|
"operationId": "fastapi_admin_cache_save_post_v1_admin_cache_save_post",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Response Fastapi Admin Cache Save Post V1 Admin Cache Save Post"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/admin/cache/load": {
|
|
"post": {
|
|
"tags": [
|
|
"admin"
|
|
],
|
|
"summary": "Fastapi Admin Cache Load Post",
|
|
"description": "Load cache management data.\n\nReturns:\n data (dict): The management data that was loaded.",
|
|
"operationId": "fastapi_admin_cache_load_post_v1_admin_cache_load_post",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Response Fastapi Admin Cache Load Post V1 Admin Cache Load Post"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/admin/cache": {
|
|
"get": {
|
|
"tags": [
|
|
"admin"
|
|
],
|
|
"summary": "Fastapi Admin Cache Get",
|
|
"description": "Current cache management data.\n\nReturns:\n data (dict): The management data.",
|
|
"operationId": "fastapi_admin_cache_get_v1_admin_cache_get",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Response Fastapi Admin Cache Get V1 Admin Cache Get"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/admin/server/restart": {
|
|
"post": {
|
|
"tags": [
|
|
"admin"
|
|
],
|
|
"summary": "Fastapi Admin Server Restart Post",
|
|
"description": "Restart the server.\n\nRestart EOS properly by starting a new instance before exiting the old one.",
|
|
"operationId": "fastapi_admin_server_restart_post_v1_admin_server_restart_post",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Response Fastapi Admin Server Restart Post V1 Admin Server Restart Post"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/admin/server/shutdown": {
|
|
"post": {
|
|
"tags": [
|
|
"admin"
|
|
],
|
|
"summary": "Fastapi Admin Server Shutdown Post",
|
|
"description": "Shutdown the server.",
|
|
"operationId": "fastapi_admin_server_shutdown_post_v1_admin_server_shutdown_post",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Response Fastapi Admin Server Shutdown Post V1 Admin Server Shutdown Post"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/health": {
|
|
"get": {
|
|
"summary": "Fastapi Health Get",
|
|
"description": "Health check endpoint to verify that the EOS server is alive.",
|
|
"operationId": "fastapi_health_get_v1_health_get",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/config/reset": {
|
|
"post": {
|
|
"tags": [
|
|
"config"
|
|
],
|
|
"summary": "Fastapi Config Reset Post",
|
|
"description": "Reset the configuration to the EOS configuration file.\n\nReturns:\n configuration (ConfigEOS): The current configuration after update.",
|
|
"operationId": "fastapi_config_reset_post_v1_config_reset_post",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ConfigEOS"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/config/file": {
|
|
"put": {
|
|
"tags": [
|
|
"config"
|
|
],
|
|
"summary": "Fastapi Config File Put",
|
|
"description": "Save the current configuration to the EOS configuration file.\n\nReturns:\n configuration (ConfigEOS): The current configuration that was saved.",
|
|
"operationId": "fastapi_config_file_put_v1_config_file_put",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ConfigEOS"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/config": {
|
|
"get": {
|
|
"tags": [
|
|
"config"
|
|
],
|
|
"summary": "Fastapi Config Get",
|
|
"description": "Get the current configuration.\n\nReturns:\n configuration (ConfigEOS): The current configuration.",
|
|
"operationId": "fastapi_config_get_v1_config_get",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ConfigEOS"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"config"
|
|
],
|
|
"summary": "Fastapi Config Put",
|
|
"description": "Update the current config with the provided settings.\n\nNote that for any setting value that is None or unset, the configuration will fall back to\nvalues from other sources such as environment variables, the EOS configuration file, or default\nvalues.\n\nArgs:\n settings (SettingsEOS): The settings to write into the current settings.\n\nReturns:\n configuration (ConfigEOS): The current configuration after the write.",
|
|
"operationId": "fastapi_config_put_v1_config_put",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/SettingsEOS"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ConfigEOS"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/config/{path}": {
|
|
"put": {
|
|
"tags": [
|
|
"config"
|
|
],
|
|
"summary": "Fastapi Config Put Key",
|
|
"description": "Update a nested key or index in the config model.\n\nArgs:\n path (str): The nested path to the key (e.g., \"general/latitude\" or \"optimize/nested_list/0\").\n value (Any): The new value to assign to the key or index at path.\n\nReturns:\n configuration (ConfigEOS): The current configuration after the update.",
|
|
"operationId": "fastapi_config_put_key_v1_config__path__put",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The nested path to the configuration key (e.g., general/latitude).",
|
|
"title": "Path"
|
|
},
|
|
"description": "The nested path to the configuration key (e.g., general/latitude)."
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "The value to assign to the specified configuration path (can be None).",
|
|
"title": "Value"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ConfigEOS"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"config"
|
|
],
|
|
"summary": "Fastapi Config Get Key",
|
|
"description": "Get the value of a nested key or index in the config model.\n\nArgs:\n path (str): The nested path to the key (e.g., \"general/latitude\" or \"optimize/nested_list/0\").\n\nReturns:\n value (Any): The value of the selected nested key.",
|
|
"operationId": "fastapi_config_get_key_v1_config__path__get",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The nested path to the configuration key (e.g., general/latitude).",
|
|
"title": "Path"
|
|
},
|
|
"description": "The nested path to the configuration key (e.g., general/latitude)."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/logging/log": {
|
|
"get": {
|
|
"tags": [
|
|
"logging"
|
|
],
|
|
"summary": "Fastapi Logging Get Log",
|
|
"description": "Get structured log entries from the EOS log file.\n\nFilters and returns log entries based on the specified query parameters. The log\nfile is expected to contain newline-delimited JSON entries.\n\nArgs:\n limit (int): Maximum number of entries to return.\n level (Optional[str]): Filter logs by severity level (e.g., DEBUG, INFO).\n contains (Optional[str]): Return only logs that include this string in the message.\n regex (Optional[str]): Return logs that match this regular expression in the message.\n from_time (Optional[str]): ISO 8601 timestamp to filter logs not older than this.\n to_time (Optional[str]): ISO 8601 timestamp to filter logs not newer than this.\n tail (bool): If True, fetch the most recent log entries (like `tail`).\n\nReturns:\n JSONResponse: A JSON list of log entries.",
|
|
"operationId": "fastapi_logging_get_log_v1_logging_log_get",
|
|
"parameters": [
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"description": "Maximum number of log entries to return.",
|
|
"default": 100,
|
|
"title": "Limit"
|
|
},
|
|
"description": "Maximum number of log entries to return."
|
|
},
|
|
{
|
|
"name": "level",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Filter by log level (e.g., INFO, ERROR).",
|
|
"title": "Level"
|
|
},
|
|
"description": "Filter by log level (e.g., INFO, ERROR)."
|
|
},
|
|
{
|
|
"name": "contains",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Filter logs containing this substring.",
|
|
"title": "Contains"
|
|
},
|
|
"description": "Filter logs containing this substring."
|
|
},
|
|
{
|
|
"name": "regex",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Filter logs by matching regex in message.",
|
|
"title": "Regex"
|
|
},
|
|
"description": "Filter logs by matching regex in message."
|
|
},
|
|
{
|
|
"name": "from_time",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Start time (ISO format) for filtering logs.",
|
|
"title": "From Time"
|
|
},
|
|
"description": "Start time (ISO format) for filtering logs."
|
|
},
|
|
{
|
|
"name": "to_time",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "End time (ISO format) for filtering logs.",
|
|
"title": "To Time"
|
|
},
|
|
"description": "End time (ISO format) for filtering logs."
|
|
},
|
|
{
|
|
"name": "tail",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "boolean",
|
|
"description": "If True, returns the most recent lines (tail mode).",
|
|
"default": false,
|
|
"title": "Tail"
|
|
},
|
|
"description": "If True, returns the most recent lines (tail mode)."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/resource/status": {
|
|
"get": {
|
|
"tags": [
|
|
"resource"
|
|
],
|
|
"summary": "Fastapi Devices Status Get",
|
|
"description": "Get the latest status of a resource/ device.\n\nReturn:\n latest_status: The latest status of a resource/ device.",
|
|
"operationId": "fastapi_devices_status_get_v1_resource_status_get",
|
|
"parameters": [
|
|
{
|
|
"name": "resource_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Resource ID.",
|
|
"title": "Resource Id"
|
|
},
|
|
"description": "Resource ID."
|
|
},
|
|
{
|
|
"name": "actuator_id",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Actuator ID.",
|
|
"title": "Actuator Id"
|
|
},
|
|
"description": "Actuator ID."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PowerMeasurement-Output"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/EnergyMeasurement-Output"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PPBCPowerProfileStatus-Output"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OMBCStatus"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FRBCActuatorStatus"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FRBCEnergyStatus-Output"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FRBCStorageStatus"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FRBCTimerStatus"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/DDBCActuatorStatus"
|
|
}
|
|
],
|
|
"discriminator": {
|
|
"propertyName": "type",
|
|
"mapping": {
|
|
"PowerMeasurement": "#/components/schemas/PowerMeasurement-Output",
|
|
"EnergyMeasurement": "#/components/schemas/EnergyMeasurement-Output",
|
|
"PPBCPowerProfileStatus": "#/components/schemas/PPBCPowerProfileStatus-Output",
|
|
"OMBCStatus": "#/components/schemas/OMBCStatus",
|
|
"FRBCActuatorStatus": "#/components/schemas/FRBCActuatorStatus",
|
|
"FRBCEnergyStatus": "#/components/schemas/FRBCEnergyStatus-Output",
|
|
"FRBCStorageStatus": "#/components/schemas/FRBCStorageStatus",
|
|
"FRBCTimerStatus": "#/components/schemas/FRBCTimerStatus",
|
|
"DDBCActuatorStatus": "#/components/schemas/DDBCActuatorStatus"
|
|
}
|
|
},
|
|
"title": "Response Fastapi Devices Status Get V1 Resource Status Get"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"resource"
|
|
],
|
|
"summary": "Fastapi Devices Status Put",
|
|
"description": "Update the status of a resource/ device.\n\nReturn:\n latest_status: The latest status of a resource/ device.",
|
|
"operationId": "fastapi_devices_status_put_v1_resource_status_put",
|
|
"parameters": [
|
|
{
|
|
"name": "resource_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Resource ID.",
|
|
"title": "Resource Id"
|
|
},
|
|
"description": "Resource ID."
|
|
},
|
|
{
|
|
"name": "actuator_id",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Actuator ID.",
|
|
"title": "Actuator Id"
|
|
},
|
|
"description": "Actuator ID."
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PowerMeasurement-Input"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/EnergyMeasurement-Input"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PPBCPowerProfileStatus-Input"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OMBCStatus"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FRBCActuatorStatus"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FRBCEnergyStatus-Input"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FRBCStorageStatus"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FRBCTimerStatus"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/DDBCActuatorStatus"
|
|
}
|
|
],
|
|
"description": "Resource Status.",
|
|
"title": "Status"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PowerMeasurement-Output"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/EnergyMeasurement-Output"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PPBCPowerProfileStatus-Output"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OMBCStatus"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FRBCActuatorStatus"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FRBCEnergyStatus-Output"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FRBCStorageStatus"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FRBCTimerStatus"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/DDBCActuatorStatus"
|
|
}
|
|
],
|
|
"discriminator": {
|
|
"propertyName": "type",
|
|
"mapping": {
|
|
"PowerMeasurement": "#/components/schemas/PowerMeasurement-Output",
|
|
"EnergyMeasurement": "#/components/schemas/EnergyMeasurement-Output",
|
|
"PPBCPowerProfileStatus": "#/components/schemas/PPBCPowerProfileStatus-Output",
|
|
"OMBCStatus": "#/components/schemas/OMBCStatus",
|
|
"FRBCActuatorStatus": "#/components/schemas/FRBCActuatorStatus",
|
|
"FRBCEnergyStatus": "#/components/schemas/FRBCEnergyStatus-Output",
|
|
"FRBCStorageStatus": "#/components/schemas/FRBCStorageStatus",
|
|
"FRBCTimerStatus": "#/components/schemas/FRBCTimerStatus",
|
|
"DDBCActuatorStatus": "#/components/schemas/DDBCActuatorStatus"
|
|
}
|
|
},
|
|
"title": "Response Fastapi Devices Status Put V1 Resource Status Put"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/measurement/keys": {
|
|
"get": {
|
|
"tags": [
|
|
"measurement"
|
|
],
|
|
"summary": "Fastapi Measurement Keys Get",
|
|
"description": "Get a list of available measurement keys.",
|
|
"operationId": "fastapi_measurement_keys_get_v1_measurement_keys_get",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"title": "Response Fastapi Measurement Keys Get V1 Measurement Keys Get"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/measurement/series": {
|
|
"get": {
|
|
"tags": [
|
|
"measurement"
|
|
],
|
|
"summary": "Fastapi Measurement Series Get",
|
|
"description": "Get the measurements of given key as series.",
|
|
"operationId": "fastapi_measurement_series_get_v1_measurement_series_get",
|
|
"parameters": [
|
|
{
|
|
"name": "key",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Measurement key.",
|
|
"title": "Key"
|
|
},
|
|
"description": "Measurement key."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PydanticDateTimeSeries"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"measurement"
|
|
],
|
|
"summary": "Fastapi Measurement Series Put",
|
|
"description": "Merge measurement given as series into given key.",
|
|
"operationId": "fastapi_measurement_series_put_v1_measurement_series_put",
|
|
"parameters": [
|
|
{
|
|
"name": "key",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Measurement key.",
|
|
"title": "Key"
|
|
},
|
|
"description": "Measurement key."
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PydanticDateTimeSeries"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PydanticDateTimeSeries"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/measurement/value": {
|
|
"put": {
|
|
"tags": [
|
|
"measurement"
|
|
],
|
|
"summary": "Fastapi Measurement Value Put",
|
|
"description": "Merge the measurement of given key and value into EOS measurements at given datetime.",
|
|
"operationId": "fastapi_measurement_value_put_v1_measurement_value_put",
|
|
"parameters": [
|
|
{
|
|
"name": "datetime",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Datetime.",
|
|
"title": "Datetime"
|
|
},
|
|
"description": "Datetime."
|
|
},
|
|
{
|
|
"name": "key",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Measurement key.",
|
|
"title": "Key"
|
|
},
|
|
"description": "Measurement key."
|
|
},
|
|
{
|
|
"name": "value",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"title": "Value"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PydanticDateTimeSeries"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/measurement/dataframe": {
|
|
"put": {
|
|
"tags": [
|
|
"measurement"
|
|
],
|
|
"summary": "Fastapi Measurement Dataframe Put",
|
|
"description": "Merge the measurement data given as dataframe into EOS measurements.",
|
|
"operationId": "fastapi_measurement_dataframe_put_v1_measurement_dataframe_put",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PydanticDateTimeDataFrame"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/measurement/data": {
|
|
"put": {
|
|
"tags": [
|
|
"measurement"
|
|
],
|
|
"summary": "Fastapi Measurement Data Put",
|
|
"description": "Merge the measurement data given as datetime data into EOS measurements.",
|
|
"operationId": "fastapi_measurement_data_put_v1_measurement_data_put",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PydanticDateTimeData"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/prediction/providers": {
|
|
"get": {
|
|
"tags": [
|
|
"prediction"
|
|
],
|
|
"summary": "Fastapi Prediction Providers Get",
|
|
"description": "Get a list of available prediction providers.\n\nArgs:\n enabled (bool): Return enabled/disabled providers. If unset, return all providers.",
|
|
"operationId": "fastapi_prediction_providers_get_v1_prediction_providers_get",
|
|
"parameters": [
|
|
{
|
|
"name": "enabled",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Enabled"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"title": "Response Fastapi Prediction Providers Get V1 Prediction Providers Get"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/prediction/keys": {
|
|
"get": {
|
|
"tags": [
|
|
"prediction"
|
|
],
|
|
"summary": "Fastapi Prediction Keys Get",
|
|
"description": "Get a list of available prediction keys.",
|
|
"operationId": "fastapi_prediction_keys_get_v1_prediction_keys_get",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"title": "Response Fastapi Prediction Keys Get V1 Prediction Keys Get"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/prediction/series": {
|
|
"get": {
|
|
"tags": [
|
|
"prediction"
|
|
],
|
|
"summary": "Fastapi Prediction Series Get",
|
|
"description": "Get prediction for given key within given date range as series.\n\nArgs:\n key (str): Prediction key\n start_datetime (Optional[str]): Starting datetime (inclusive).\n Defaults to start datetime of latest prediction.\n end_datetime (Optional[str]: Ending datetime (exclusive).\n Defaults to end datetime of latest prediction.",
|
|
"operationId": "fastapi_prediction_series_get_v1_prediction_series_get",
|
|
"parameters": [
|
|
{
|
|
"name": "key",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Prediction key.",
|
|
"title": "Key"
|
|
},
|
|
"description": "Prediction key."
|
|
},
|
|
{
|
|
"name": "start_datetime",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Starting datetime (inclusive).",
|
|
"title": "Start Datetime"
|
|
},
|
|
"description": "Starting datetime (inclusive)."
|
|
},
|
|
{
|
|
"name": "end_datetime",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Ending datetime (exclusive).",
|
|
"title": "End Datetime"
|
|
},
|
|
"description": "Ending datetime (exclusive)."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PydanticDateTimeSeries"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/prediction/dataframe": {
|
|
"get": {
|
|
"tags": [
|
|
"prediction"
|
|
],
|
|
"summary": "Fastapi Prediction Dataframe Get",
|
|
"description": "Get prediction for given key within given date range as series.\n\nArgs:\n key (str): Prediction key\n start_datetime (Optional[str]): Starting datetime (inclusive).\n Defaults to start datetime of latest prediction.\n end_datetime (Optional[str]: Ending datetime (exclusive).\n\nDefaults to end datetime of latest prediction.",
|
|
"operationId": "fastapi_prediction_dataframe_get_v1_prediction_dataframe_get",
|
|
"parameters": [
|
|
{
|
|
"name": "keys",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Prediction keys.",
|
|
"title": "Keys"
|
|
},
|
|
"description": "Prediction keys."
|
|
},
|
|
{
|
|
"name": "start_datetime",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Starting datetime (inclusive).",
|
|
"title": "Start Datetime"
|
|
},
|
|
"description": "Starting datetime (inclusive)."
|
|
},
|
|
{
|
|
"name": "end_datetime",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Ending datetime (exclusive).",
|
|
"title": "End Datetime"
|
|
},
|
|
"description": "Ending datetime (exclusive)."
|
|
},
|
|
{
|
|
"name": "interval",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Time duration for each interval. Defaults to 1 hour.",
|
|
"title": "Interval"
|
|
},
|
|
"description": "Time duration for each interval. Defaults to 1 hour."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PydanticDateTimeDataFrame"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/prediction/list": {
|
|
"get": {
|
|
"tags": [
|
|
"prediction"
|
|
],
|
|
"summary": "Fastapi Prediction List Get",
|
|
"description": "Get prediction for given key within given date range as value list.\n\nArgs:\n key (str): Prediction key\n start_datetime (Optional[str]): Starting datetime (inclusive).\n Defaults to start datetime of latest prediction.\n end_datetime (Optional[str]: Ending datetime (exclusive).\n Defaults to end datetime of latest prediction.\n interval (Optional[str]): Time duration for each interval.\n Defaults to 1 hour.",
|
|
"operationId": "fastapi_prediction_list_get_v1_prediction_list_get",
|
|
"parameters": [
|
|
{
|
|
"name": "key",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Prediction key.",
|
|
"title": "Key"
|
|
},
|
|
"description": "Prediction key."
|
|
},
|
|
{
|
|
"name": "start_datetime",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Starting datetime (inclusive).",
|
|
"title": "Start Datetime"
|
|
},
|
|
"description": "Starting datetime (inclusive)."
|
|
},
|
|
{
|
|
"name": "end_datetime",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Ending datetime (exclusive).",
|
|
"title": "End Datetime"
|
|
},
|
|
"description": "Ending datetime (exclusive)."
|
|
},
|
|
{
|
|
"name": "interval",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Time duration for each interval. Defaults to 1 hour.",
|
|
"title": "Interval"
|
|
},
|
|
"description": "Time duration for each interval. Defaults to 1 hour."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {},
|
|
"title": "Response Fastapi Prediction List Get V1 Prediction List Get"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/prediction/import/{provider_id}": {
|
|
"put": {
|
|
"tags": [
|
|
"prediction"
|
|
],
|
|
"summary": "Fastapi Prediction Import Provider",
|
|
"description": "Import prediction for given provider ID.\n\nArgs:\n provider_id: ID of provider to update.\n data: Prediction data.\n force_enable: Update data even if provider is disabled.\n Defaults to False.",
|
|
"operationId": "fastapi_prediction_import_provider_v1_prediction_import__provider_id__put",
|
|
"parameters": [
|
|
{
|
|
"name": "provider_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Provider ID.",
|
|
"title": "Provider Id"
|
|
},
|
|
"description": "Provider ID."
|
|
},
|
|
{
|
|
"name": "force_enable",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Force Enable"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PydanticDateTimeDataFrame"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PydanticDateTimeData"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"additionalProperties": true
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/prediction/update": {
|
|
"post": {
|
|
"tags": [
|
|
"prediction"
|
|
],
|
|
"summary": "Fastapi Prediction Update",
|
|
"description": "Update predictions for all providers.\n\nArgs:\n force_update: Update data even if it is already cached.\n Defaults to False.\n force_enable: Update data even if provider is disabled.\n Defaults to False.",
|
|
"operationId": "fastapi_prediction_update_v1_prediction_update_post",
|
|
"parameters": [
|
|
{
|
|
"name": "force_update",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": false,
|
|
"title": "Force Update"
|
|
}
|
|
},
|
|
{
|
|
"name": "force_enable",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": false,
|
|
"title": "Force Enable"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/prediction/update/{provider_id}": {
|
|
"post": {
|
|
"tags": [
|
|
"prediction"
|
|
],
|
|
"summary": "Fastapi Prediction Update Provider",
|
|
"description": "Update predictions for given provider ID.\n\nArgs:\n provider_id: ID of provider to update.\n force_update: Update data even if it is already cached.\n Defaults to False.\n force_enable: Update data even if provider is disabled.\n Defaults to False.",
|
|
"operationId": "fastapi_prediction_update_provider_v1_prediction_update__provider_id__post",
|
|
"parameters": [
|
|
{
|
|
"name": "provider_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Provider Id"
|
|
}
|
|
},
|
|
{
|
|
"name": "force_update",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": false,
|
|
"title": "Force Update"
|
|
}
|
|
},
|
|
{
|
|
"name": "force_enable",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": false,
|
|
"title": "Force Enable"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/energy-management/optimization/solution": {
|
|
"get": {
|
|
"tags": [
|
|
"energy-management"
|
|
],
|
|
"summary": "Fastapi Energy Management Optimization Solution Get",
|
|
"description": "Get the latest solution of the optimization.",
|
|
"operationId": "fastapi_energy_management_optimization_solution_get_v1_energy_management_optimization_solution_get",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OptimizationSolution"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/energy-management/plan": {
|
|
"get": {
|
|
"tags": [
|
|
"energy-management"
|
|
],
|
|
"summary": "Fastapi Energy Management Plan Get",
|
|
"description": "Get the latest energy management plan.",
|
|
"operationId": "fastapi_energy_management_plan_get_v1_energy_management_plan_get",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/EnergyManagementPlan"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/strompreis": {
|
|
"get": {
|
|
"tags": [
|
|
"prediction"
|
|
],
|
|
"summary": "Fastapi Strompreis",
|
|
"description": "Deprecated: Electricity Market Price Prediction per Wh (\u20ac/Wh).\n\nElectricity prices start at 00.00.00 today and are provided for 48 hours.\nIf no prices are available the missing ones at the start of the series are\nfilled with the first available price.\n\nNote:\n Electricity price charges are added.\n\nNote:\n Set ElecPriceAkkudoktor as provider, then update data with\n '/v1/prediction/update'\n and then request data with\n '/v1/prediction/list?key=elecprice_marketprice_wh' or\n '/v1/prediction/list?key=elecprice_marketprice_kwh' instead.",
|
|
"operationId": "fastapi_strompreis_strompreis_get",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Response Fastapi Strompreis Strompreis Get"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/gesamtlast": {
|
|
"post": {
|
|
"tags": [
|
|
"prediction"
|
|
],
|
|
"summary": "Fastapi Gesamtlast",
|
|
"description": "Deprecated: Total Load Prediction with adjustment.\n\nEndpoint to handle total load prediction adjusted by latest measured data.\n\nTotal load prediction starts at 00.00.00 today and is provided for 48 hours.\nIf no prediction values are available the missing ones at the start of the series are\nfilled with the first available prediction value.\n\nNote:\n Use '/v1/prediction/list?key=load_mean_adjusted' instead.\n Load energy meter readings to be added to EOS measurement by:\n '/v1/measurement/value' or\n '/v1/measurement/series' or\n '/v1/measurement/dataframe' or\n '/v1/measurement/data'",
|
|
"operationId": "fastapi_gesamtlast_gesamtlast_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/GesamtlastRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Response Fastapi Gesamtlast Gesamtlast Post"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/gesamtlast_simple": {
|
|
"get": {
|
|
"tags": [
|
|
"prediction"
|
|
],
|
|
"summary": "Fastapi Gesamtlast Simple",
|
|
"description": "Deprecated: Total Load Prediction.\n\nEndpoint to handle total load prediction.\n\nTotal load prediction starts at 00.00.00 today and is provided for 48 hours.\nIf no prediction values are available the missing ones at the start of the series are\nfilled with the first available prediction value.\n\nArgs:\n year_energy (float): Yearly energy consumption in Wh.\n\nNote:\n Set LoadAkkudoktor as provider, then update data with\n '/v1/prediction/update'\n and then request data with\n '/v1/prediction/list?key=load_mean' instead.",
|
|
"operationId": "fastapi_gesamtlast_simple_gesamtlast_simple_get",
|
|
"parameters": [
|
|
{
|
|
"name": "year_energy",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "number",
|
|
"title": "Year Energy"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"title": "Response Fastapi Gesamtlast Simple Gesamtlast Simple Get"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/pvforecast": {
|
|
"get": {
|
|
"tags": [
|
|
"prediction"
|
|
],
|
|
"summary": "Fastapi Pvforecast",
|
|
"description": "Deprecated: PV Forecast Prediction.\n\nEndpoint to handle PV forecast prediction.\n\nPVForecast starts at 00.00.00 today and is provided for 48 hours.\nIf no forecast values are available the missing ones at the start of the series are\nfilled with the first available forecast value.\n\nNote:\n Set PVForecastAkkudoktor as provider, then update data with\n '/v1/prediction/update'\n and then request data with\n '/v1/prediction/list?key=pvforecast_ac_power' and\n '/v1/prediction/list?key=pvforecastakkudoktor_temp_air' instead.",
|
|
"operationId": "fastapi_pvforecast_pvforecast_get",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ForecastResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/optimize": {
|
|
"post": {
|
|
"tags": [
|
|
"optimize"
|
|
],
|
|
"summary": "Fastapi Optimize",
|
|
"description": "Deprecated: Optimize.\n\nEndpoint to handle optimization.\n\nNote:\n Use automatic optimization instead.",
|
|
"operationId": "fastapi_optimize_optimize_post",
|
|
"parameters": [
|
|
{
|
|
"name": "start_hour",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Defaults to current hour of the day.",
|
|
"title": "Start Hour"
|
|
},
|
|
"description": "Defaults to current hour of the day."
|
|
},
|
|
{
|
|
"name": "ngen",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Number of indivuals to generate for genetic algorithm.",
|
|
"title": "Ngen"
|
|
},
|
|
"description": "Number of indivuals to generate for genetic algorithm."
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/GeneticOptimizationParameters"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/GeneticSolution"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/visualization_results.pdf": {
|
|
"get": {
|
|
"tags": [
|
|
"optimize"
|
|
],
|
|
"summary": "Get Pdf",
|
|
"operationId": "get_pdf_visualization_results_pdf_get",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/pdf": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"BatteriesCommonSettings-Input": {
|
|
"properties": {
|
|
"device_id": {
|
|
"type": "string",
|
|
"title": "Device Id",
|
|
"description": "ID of device",
|
|
"default": "<unknown>",
|
|
"examples": [
|
|
"battery1",
|
|
"ev1",
|
|
"inverter1",
|
|
"dishwasher"
|
|
]
|
|
},
|
|
"capacity_wh": {
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0.0,
|
|
"title": "Capacity Wh",
|
|
"description": "Capacity [Wh].",
|
|
"default": 8000,
|
|
"examples": [
|
|
8000
|
|
]
|
|
},
|
|
"charging_efficiency": {
|
|
"type": "number",
|
|
"maximum": 1.0,
|
|
"exclusiveMinimum": 0.0,
|
|
"title": "Charging Efficiency",
|
|
"description": "Charging efficiency [0.01 ... 1.00].",
|
|
"default": 0.88,
|
|
"examples": [
|
|
0.88
|
|
]
|
|
},
|
|
"discharging_efficiency": {
|
|
"type": "number",
|
|
"maximum": 1.0,
|
|
"exclusiveMinimum": 0.0,
|
|
"title": "Discharging Efficiency",
|
|
"description": "Discharge efficiency [0.01 ... 1.00].",
|
|
"default": 0.88,
|
|
"examples": [
|
|
0.88
|
|
]
|
|
},
|
|
"levelized_cost_of_storage_kwh": {
|
|
"type": "number",
|
|
"title": "Levelized Cost Of Storage Kwh",
|
|
"description": "Levelized cost of storage (LCOS), the average lifetime cost of delivering one kWh [\u20ac/kWh].",
|
|
"default": 0.0,
|
|
"examples": [
|
|
0.12
|
|
]
|
|
},
|
|
"max_charge_power_w": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number",
|
|
"exclusiveMinimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Charge Power W",
|
|
"description": "Maximum charging power [W].",
|
|
"default": 5000,
|
|
"examples": [
|
|
5000
|
|
]
|
|
},
|
|
"min_charge_power_w": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number",
|
|
"exclusiveMinimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Min Charge Power W",
|
|
"description": "Minimum charging power [W].",
|
|
"default": 50,
|
|
"examples": [
|
|
50
|
|
]
|
|
},
|
|
"charge_rates": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Charge Rates",
|
|
"description": "Charge rates as factor of maximum charging power [0.00 ... 1.00]. None denotes all charge rates are available.",
|
|
"examples": [
|
|
[
|
|
0.0,
|
|
0.25,
|
|
0.5,
|
|
0.75,
|
|
1.0
|
|
],
|
|
null
|
|
]
|
|
},
|
|
"min_soc_percentage": {
|
|
"type": "integer",
|
|
"maximum": 100.0,
|
|
"minimum": 0.0,
|
|
"title": "Min Soc Percentage",
|
|
"description": "Minimum state of charge (SOC) as percentage of capacity [%].",
|
|
"default": 0,
|
|
"examples": [
|
|
10
|
|
]
|
|
},
|
|
"max_soc_percentage": {
|
|
"type": "integer",
|
|
"maximum": 100.0,
|
|
"minimum": 0.0,
|
|
"title": "Max Soc Percentage",
|
|
"description": "Maximum state of charge (SOC) as percentage of capacity [%].",
|
|
"default": 100,
|
|
"examples": [
|
|
100
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "BatteriesCommonSettings",
|
|
"description": "Battery devices base settings."
|
|
},
|
|
"BatteriesCommonSettings-Output": {
|
|
"properties": {
|
|
"device_id": {
|
|
"type": "string",
|
|
"title": "Device Id",
|
|
"description": "ID of device",
|
|
"default": "<unknown>",
|
|
"examples": [
|
|
"battery1",
|
|
"ev1",
|
|
"inverter1",
|
|
"dishwasher"
|
|
]
|
|
},
|
|
"capacity_wh": {
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0.0,
|
|
"title": "Capacity Wh",
|
|
"description": "Capacity [Wh].",
|
|
"default": 8000,
|
|
"examples": [
|
|
8000
|
|
]
|
|
},
|
|
"charging_efficiency": {
|
|
"type": "number",
|
|
"maximum": 1.0,
|
|
"exclusiveMinimum": 0.0,
|
|
"title": "Charging Efficiency",
|
|
"description": "Charging efficiency [0.01 ... 1.00].",
|
|
"default": 0.88,
|
|
"examples": [
|
|
0.88
|
|
]
|
|
},
|
|
"discharging_efficiency": {
|
|
"type": "number",
|
|
"maximum": 1.0,
|
|
"exclusiveMinimum": 0.0,
|
|
"title": "Discharging Efficiency",
|
|
"description": "Discharge efficiency [0.01 ... 1.00].",
|
|
"default": 0.88,
|
|
"examples": [
|
|
0.88
|
|
]
|
|
},
|
|
"levelized_cost_of_storage_kwh": {
|
|
"type": "number",
|
|
"title": "Levelized Cost Of Storage Kwh",
|
|
"description": "Levelized cost of storage (LCOS), the average lifetime cost of delivering one kWh [\u20ac/kWh].",
|
|
"default": 0.0,
|
|
"examples": [
|
|
0.12
|
|
]
|
|
},
|
|
"max_charge_power_w": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number",
|
|
"exclusiveMinimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Charge Power W",
|
|
"description": "Maximum charging power [W].",
|
|
"default": 5000,
|
|
"examples": [
|
|
5000
|
|
]
|
|
},
|
|
"min_charge_power_w": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number",
|
|
"exclusiveMinimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Min Charge Power W",
|
|
"description": "Minimum charging power [W].",
|
|
"default": 50,
|
|
"examples": [
|
|
50
|
|
]
|
|
},
|
|
"charge_rates": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Charge Rates",
|
|
"description": "Charge rates as factor of maximum charging power [0.00 ... 1.00]. None denotes all charge rates are available.",
|
|
"examples": [
|
|
[
|
|
0.0,
|
|
0.25,
|
|
0.5,
|
|
0.75,
|
|
1.0
|
|
],
|
|
null
|
|
]
|
|
},
|
|
"min_soc_percentage": {
|
|
"type": "integer",
|
|
"maximum": 100.0,
|
|
"minimum": 0.0,
|
|
"title": "Min Soc Percentage",
|
|
"description": "Minimum state of charge (SOC) as percentage of capacity [%].",
|
|
"default": 0,
|
|
"examples": [
|
|
10
|
|
]
|
|
},
|
|
"max_soc_percentage": {
|
|
"type": "integer",
|
|
"maximum": 100.0,
|
|
"minimum": 0.0,
|
|
"title": "Max Soc Percentage",
|
|
"description": "Maximum state of charge (SOC) as percentage of capacity [%].",
|
|
"default": 100,
|
|
"examples": [
|
|
100
|
|
]
|
|
},
|
|
"measurement_key_soc_factor": {
|
|
"type": "string",
|
|
"title": "Measurement Key Soc Factor",
|
|
"description": "Measurement key for the battery state of charge (SoC) as factor of total capacity [0.0 ... 1.0].",
|
|
"readOnly": true
|
|
},
|
|
"measurement_key_power_l1_w": {
|
|
"type": "string",
|
|
"title": "Measurement Key Power L1 W",
|
|
"description": "Measurement key for the L1 power the battery is charged or discharged with [W].",
|
|
"readOnly": true
|
|
},
|
|
"measurement_key_power_l2_w": {
|
|
"type": "string",
|
|
"title": "Measurement Key Power L2 W",
|
|
"description": "Measurement key for the L2 power the battery is charged or discharged with [W].",
|
|
"readOnly": true
|
|
},
|
|
"measurement_key_power_l3_w": {
|
|
"type": "string",
|
|
"title": "Measurement Key Power L3 W",
|
|
"description": "Measurement key for the L3 power the battery is charged or discharged with [W].",
|
|
"readOnly": true
|
|
},
|
|
"measurement_key_power_3_phase_sym_w": {
|
|
"type": "string",
|
|
"title": "Measurement Key Power 3 Phase Sym W",
|
|
"description": "Measurement key for the symmetric 3 phase power the battery is charged or discharged with [W].",
|
|
"readOnly": true
|
|
},
|
|
"measurement_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Measurement Keys",
|
|
"description": "Measurement keys for the battery stati that are measurements.\n\nBattery SoC, power.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"measurement_key_soc_factor",
|
|
"measurement_key_power_l1_w",
|
|
"measurement_key_power_l2_w",
|
|
"measurement_key_power_l3_w",
|
|
"measurement_key_power_3_phase_sym_w",
|
|
"measurement_keys"
|
|
],
|
|
"title": "BatteriesCommonSettings",
|
|
"description": "Battery devices base settings."
|
|
},
|
|
"CacheCommonSettings": {
|
|
"properties": {
|
|
"subpath": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "path"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Subpath",
|
|
"description": "Sub-path for the EOS cache data directory.",
|
|
"default": "cache"
|
|
},
|
|
"cleanup_interval": {
|
|
"type": "number",
|
|
"title": "Cleanup Interval",
|
|
"description": "Intervall in seconds for EOS file cache cleanup.",
|
|
"default": 300
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "CacheCommonSettings",
|
|
"description": "Cache Configuration."
|
|
},
|
|
"CommodityQuantity": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ELECTRIC.POWER.L1",
|
|
"ELECTRIC.POWER.L2",
|
|
"ELECTRIC.POWER.L3",
|
|
"ELECTRIC.POWER.3_PHASE_SYM",
|
|
"NATURAL_GAS.FLOW_RATE",
|
|
"HYDROGEN.FLOW_RATE",
|
|
"HEAT.TEMPERATURE",
|
|
"HEAT.FLOW_RATE",
|
|
"HEAT.THERMAL_POWER",
|
|
"OIL.FLOW_RATE",
|
|
"CURRENCY"
|
|
],
|
|
"title": "CommodityQuantity",
|
|
"description": "Enumeration of specific commodity quantities and measurement types."
|
|
},
|
|
"ConfigEOS": {
|
|
"properties": {
|
|
"general": {
|
|
"$ref": "#/components/schemas/GeneralSettings-Output",
|
|
"default": {
|
|
"version": "0.1.0+dev",
|
|
"data_output_subpath": "output",
|
|
"latitude": 52.52,
|
|
"longitude": 13.405,
|
|
"timezone": "Europe/Berlin",
|
|
"config_folder_path": "/home/user/.config/net.akkudoktoreos.net",
|
|
"config_file_path": "/home/user/.config/net.akkudoktoreos.net/EOS.config.json"
|
|
}
|
|
},
|
|
"cache": {
|
|
"$ref": "#/components/schemas/CacheCommonSettings",
|
|
"default": {
|
|
"subpath": "cache",
|
|
"cleanup_interval": 300.0
|
|
}
|
|
},
|
|
"ems": {
|
|
"$ref": "#/components/schemas/EnergyManagementCommonSettings",
|
|
"default": {
|
|
"startup_delay": 5.0
|
|
}
|
|
},
|
|
"logging": {
|
|
"$ref": "#/components/schemas/LoggingCommonSettings-Output",
|
|
"default": {
|
|
"file_path": "/home/user/.local/share/net.akkudoktoreos.net/output/eos.log"
|
|
}
|
|
},
|
|
"devices": {
|
|
"$ref": "#/components/schemas/DevicesCommonSettings-Output",
|
|
"default": {
|
|
"measurement_keys": []
|
|
}
|
|
},
|
|
"measurement": {
|
|
"$ref": "#/components/schemas/MeasurementCommonSettings-Output",
|
|
"default": {
|
|
"keys": []
|
|
}
|
|
},
|
|
"optimization": {
|
|
"$ref": "#/components/schemas/OptimizationCommonSettings",
|
|
"default": {
|
|
"horizon_hours": 24,
|
|
"interval": 3600
|
|
}
|
|
},
|
|
"prediction": {
|
|
"$ref": "#/components/schemas/PredictionCommonSettings",
|
|
"default": {
|
|
"hours": 48,
|
|
"historic_hours": 48
|
|
}
|
|
},
|
|
"elecprice": {
|
|
"$ref": "#/components/schemas/ElecPriceCommonSettings-Output",
|
|
"default": {
|
|
"vat_rate": 1.19,
|
|
"provider_settings": {}
|
|
}
|
|
},
|
|
"feedintariff": {
|
|
"$ref": "#/components/schemas/FeedInTariffCommonSettings-Output",
|
|
"default": {
|
|
"provider_settings": {}
|
|
}
|
|
},
|
|
"load": {
|
|
"$ref": "#/components/schemas/LoadCommonSettings-Output",
|
|
"default": {
|
|
"provider_settings": {}
|
|
}
|
|
},
|
|
"pvforecast": {
|
|
"$ref": "#/components/schemas/PVForecastCommonSettings-Output",
|
|
"default": {
|
|
"provider_settings": {},
|
|
"max_planes": 0,
|
|
"planes_peakpower": [],
|
|
"planes_azimuth": [],
|
|
"planes_tilt": [],
|
|
"planes_userhorizon": [],
|
|
"planes_inverter_paco": []
|
|
}
|
|
},
|
|
"weather": {
|
|
"$ref": "#/components/schemas/WeatherCommonSettings-Output",
|
|
"default": {
|
|
"provider_settings": {}
|
|
}
|
|
},
|
|
"server": {
|
|
"$ref": "#/components/schemas/ServerCommonSettings",
|
|
"default": {
|
|
"host": "127.0.0.1",
|
|
"port": 8503,
|
|
"verbose": false,
|
|
"startup_eosdash": true
|
|
}
|
|
},
|
|
"utils": {
|
|
"$ref": "#/components/schemas/UtilsCommonSettings",
|
|
"default": {}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"type": "object",
|
|
"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_CONFIG_DIR` environment variable\n 2. The directory specified by the `EOS_DIR` environment variable.\n 3. A platform specific default directory for EOS.\n 4. 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 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 ```"
|
|
},
|
|
"DDBCActuatorStatus": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "DDBCActuatorStatus",
|
|
"title": "Type",
|
|
"default": "DDBCActuatorStatus"
|
|
},
|
|
"active_operation_mode_id": {
|
|
"type": "string",
|
|
"title": "Active Operation Mode Id",
|
|
"description": "Currently active operation mode ID."
|
|
},
|
|
"operation_mode_factor": {
|
|
"type": "number",
|
|
"maximum": 1.0,
|
|
"minimum": 0.0,
|
|
"title": "Operation Mode Factor",
|
|
"description": "Factor with which the operation mode is configured (0 to 1)."
|
|
},
|
|
"previous_operation_mode_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Previous Operation Mode Id",
|
|
"description": "Previously active operation mode ID. Required unless this is the first mode."
|
|
},
|
|
"transition_timestamp": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Transition Timestamp",
|
|
"description": "Timestamp of transition to the active operation mode."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"active_operation_mode_id",
|
|
"operation_mode_factor"
|
|
],
|
|
"title": "DDBCActuatorStatus",
|
|
"description": "Current status of a DDBC Actuator.\n\nProvides information about the currently active operation mode and transition history.\nUsed to track the current state of the actuator."
|
|
},
|
|
"DDBCInstruction": {
|
|
"properties": {
|
|
"id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Id",
|
|
"description": "Unique identifier of the instruction in the ResourceManager scope. If not provided and a `resource_id` is passed at instantiation, this will be auto-generated as `{resource_id}@{UUID}`."
|
|
},
|
|
"execution_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Execution Time",
|
|
"description": "Start time of the instruction execution."
|
|
},
|
|
"abnormal_condition": {
|
|
"type": "boolean",
|
|
"title": "Abnormal Condition",
|
|
"description": "Indicates if this is an instruction for abnormal conditions. Defaults to False.",
|
|
"default": false
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "DDBCInstruction",
|
|
"title": "Type",
|
|
"default": "DDBCInstruction"
|
|
},
|
|
"actuator_id": {
|
|
"type": "string",
|
|
"title": "Actuator Id",
|
|
"description": "ID of the actuator this instruction belongs to."
|
|
},
|
|
"operation_mode_id": {
|
|
"type": "string",
|
|
"title": "Operation Mode Id",
|
|
"description": "ID of the DDBC.OperationMode to apply."
|
|
},
|
|
"operation_mode_factor": {
|
|
"type": "number",
|
|
"maximum": 1.0,
|
|
"minimum": 0.0,
|
|
"title": "Operation Mode Factor",
|
|
"description": "Factor with which the operation mode should be applied (0 to 1)."
|
|
},
|
|
"resource_id": {
|
|
"type": "string",
|
|
"title": "Resource Id",
|
|
"description": "Get the resource identifier component from the instruction's `id`.\n\nAssumes the `id` follows the format `{resource_id}@{UUID}`. Extracts the resource_id part\nof the id by splitting at the last @.\n\nReturns:\n str: The resource identifier prefix of `id`, or an empty string if `id` is None.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"execution_time",
|
|
"actuator_id",
|
|
"operation_mode_id",
|
|
"operation_mode_factor",
|
|
"resource_id"
|
|
],
|
|
"title": "DDBCInstruction",
|
|
"description": "Instruction for Demand Driven Based Control (DDBC).\n\nContains information about when and how to activate a specific operation mode\nfor an actuator. Used to command resources to change their operation at a specified time."
|
|
},
|
|
"DevicesCommonSettings-Input": {
|
|
"properties": {
|
|
"batteries": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/BatteriesCommonSettings-Input"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Batteries",
|
|
"description": "List of battery devices",
|
|
"examples": [
|
|
[
|
|
{
|
|
"capacity_wh": 8000,
|
|
"device_id": "battery1"
|
|
}
|
|
]
|
|
]
|
|
},
|
|
"max_batteries": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Batteries",
|
|
"description": "Maximum number of batteries that can be set",
|
|
"examples": [
|
|
1,
|
|
2
|
|
]
|
|
},
|
|
"electric_vehicles": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/BatteriesCommonSettings-Input"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Electric Vehicles",
|
|
"description": "List of electric vehicle devices",
|
|
"examples": [
|
|
[
|
|
{
|
|
"capacity_wh": 8000,
|
|
"device_id": "battery1"
|
|
}
|
|
]
|
|
]
|
|
},
|
|
"max_electric_vehicles": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Electric Vehicles",
|
|
"description": "Maximum number of electric vehicles that can be set",
|
|
"examples": [
|
|
1,
|
|
2
|
|
]
|
|
},
|
|
"inverters": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/InverterCommonSettings-Input"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Inverters",
|
|
"description": "List of inverters",
|
|
"examples": [
|
|
[]
|
|
]
|
|
},
|
|
"max_inverters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Inverters",
|
|
"description": "Maximum number of inverters that can be set",
|
|
"examples": [
|
|
1,
|
|
2
|
|
]
|
|
},
|
|
"home_appliances": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/HomeApplianceCommonSettings-Input"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Home Appliances",
|
|
"description": "List of home appliances",
|
|
"examples": [
|
|
[]
|
|
]
|
|
},
|
|
"max_home_appliances": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Home Appliances",
|
|
"description": "Maximum number of home_appliances that can be set",
|
|
"examples": [
|
|
1,
|
|
2
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "DevicesCommonSettings",
|
|
"description": "Base configuration for devices simulation settings."
|
|
},
|
|
"DevicesCommonSettings-Output": {
|
|
"properties": {
|
|
"batteries": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/BatteriesCommonSettings-Output"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Batteries",
|
|
"description": "List of battery devices",
|
|
"examples": [
|
|
[
|
|
{
|
|
"capacity_wh": 8000,
|
|
"device_id": "battery1"
|
|
}
|
|
]
|
|
]
|
|
},
|
|
"max_batteries": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Batteries",
|
|
"description": "Maximum number of batteries that can be set",
|
|
"examples": [
|
|
1,
|
|
2
|
|
]
|
|
},
|
|
"electric_vehicles": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/BatteriesCommonSettings-Output"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Electric Vehicles",
|
|
"description": "List of electric vehicle devices",
|
|
"examples": [
|
|
[
|
|
{
|
|
"capacity_wh": 8000,
|
|
"device_id": "battery1"
|
|
}
|
|
]
|
|
]
|
|
},
|
|
"max_electric_vehicles": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Electric Vehicles",
|
|
"description": "Maximum number of electric vehicles that can be set",
|
|
"examples": [
|
|
1,
|
|
2
|
|
]
|
|
},
|
|
"inverters": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/InverterCommonSettings-Output"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Inverters",
|
|
"description": "List of inverters",
|
|
"examples": [
|
|
[]
|
|
]
|
|
},
|
|
"max_inverters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Inverters",
|
|
"description": "Maximum number of inverters that can be set",
|
|
"examples": [
|
|
1,
|
|
2
|
|
]
|
|
},
|
|
"home_appliances": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/HomeApplianceCommonSettings-Output"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Home Appliances",
|
|
"description": "List of home appliances",
|
|
"examples": [
|
|
[]
|
|
]
|
|
},
|
|
"max_home_appliances": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Home Appliances",
|
|
"description": "Maximum number of home_appliances that can be set",
|
|
"examples": [
|
|
1,
|
|
2
|
|
]
|
|
},
|
|
"measurement_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Measurement Keys",
|
|
"description": "Return the measurement keys for the resource/ device stati that are measurements.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"measurement_keys"
|
|
],
|
|
"title": "DevicesCommonSettings",
|
|
"description": "Base configuration for devices simulation settings."
|
|
},
|
|
"ElecPriceCommonProviderSettings": {
|
|
"properties": {
|
|
"ElecPriceImport": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ElecPriceImportCommonSettings"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "ElecPriceImport settings",
|
|
"examples": [
|
|
null
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "ElecPriceCommonProviderSettings",
|
|
"description": "Electricity Price Prediction Provider Configuration."
|
|
},
|
|
"ElecPriceCommonSettings-Input": {
|
|
"properties": {
|
|
"provider": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Provider",
|
|
"description": "Electricity price provider id of provider to be used.",
|
|
"examples": [
|
|
"ElecPriceAkkudoktor"
|
|
]
|
|
},
|
|
"charges_kwh": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number",
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Charges Kwh",
|
|
"description": "Electricity price charges [\u20ac/kWh]. Will be added to variable market price.",
|
|
"examples": [
|
|
0.21
|
|
]
|
|
},
|
|
"vat_rate": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number",
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Vat Rate",
|
|
"description": "VAT rate factor applied to electricity price when charges are used.",
|
|
"default": 1.19,
|
|
"examples": [
|
|
1.19
|
|
]
|
|
},
|
|
"provider_settings": {
|
|
"$ref": "#/components/schemas/ElecPriceCommonProviderSettings",
|
|
"description": "Provider settings",
|
|
"examples": [
|
|
{}
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "ElecPriceCommonSettings",
|
|
"description": "Electricity Price Prediction Configuration."
|
|
},
|
|
"ElecPriceCommonSettings-Output": {
|
|
"properties": {
|
|
"provider": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Provider",
|
|
"description": "Electricity price provider id of provider to be used.",
|
|
"examples": [
|
|
"ElecPriceAkkudoktor"
|
|
]
|
|
},
|
|
"charges_kwh": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number",
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Charges Kwh",
|
|
"description": "Electricity price charges [\u20ac/kWh]. Will be added to variable market price.",
|
|
"examples": [
|
|
0.21
|
|
]
|
|
},
|
|
"vat_rate": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number",
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Vat Rate",
|
|
"description": "VAT rate factor applied to electricity price when charges are used.",
|
|
"default": 1.19,
|
|
"examples": [
|
|
1.19
|
|
]
|
|
},
|
|
"provider_settings": {
|
|
"$ref": "#/components/schemas/ElecPriceCommonProviderSettings",
|
|
"description": "Provider settings",
|
|
"examples": [
|
|
{}
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "ElecPriceCommonSettings",
|
|
"description": "Electricity Price Prediction Configuration."
|
|
},
|
|
"ElecPriceImportCommonSettings": {
|
|
"properties": {
|
|
"import_file_path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"format": "path"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Import File Path",
|
|
"description": "Path to the file to import elecprice data from.",
|
|
"examples": [
|
|
null,
|
|
"/path/to/prices.json"
|
|
]
|
|
},
|
|
"import_json": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Import Json",
|
|
"description": "JSON string, dictionary of electricity price forecast value lists.",
|
|
"examples": [
|
|
"{\"elecprice_marketprice_wh\": [0.0003384, 0.0003318, 0.0003284]}"
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "ElecPriceImportCommonSettings",
|
|
"description": "Common settings for elecprice data import from file or JSON String."
|
|
},
|
|
"ElectricVehicleParameters": {
|
|
"properties": {
|
|
"device_id": {
|
|
"type": "string",
|
|
"title": "Device Id",
|
|
"description": "ID of electric vehicle",
|
|
"examples": [
|
|
"ev1"
|
|
]
|
|
},
|
|
"hours": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Hours",
|
|
"description": "Number of prediction hours. Defaults to global config prediction hours.",
|
|
"examples": [
|
|
null
|
|
]
|
|
},
|
|
"capacity_wh": {
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0.0,
|
|
"title": "Capacity Wh",
|
|
"description": "An integer representing the capacity of the battery in watt-hours.",
|
|
"examples": [
|
|
8000
|
|
]
|
|
},
|
|
"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": 1.0
|
|
},
|
|
"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 current state of charge (SOC) of the battery in percentage.",
|
|
"default": 0,
|
|
"examples": [
|
|
42
|
|
]
|
|
},
|
|
"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,
|
|
"examples": [
|
|
10
|
|
]
|
|
},
|
|
"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
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"type": "object",
|
|
"required": [
|
|
"device_id",
|
|
"capacity_wh"
|
|
],
|
|
"title": "ElectricVehicleParameters",
|
|
"description": "Battery Electric Vehicle Device Simulation Configuration."
|
|
},
|
|
"ElectricVehicleResult": {
|
|
"properties": {
|
|
"device_id": {
|
|
"type": "string",
|
|
"title": "Device Id",
|
|
"description": "ID of electric vehicle",
|
|
"examples": [
|
|
"ev1"
|
|
]
|
|
},
|
|
"hours": {
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0.0,
|
|
"title": "Hours",
|
|
"description": "Number of hours in the simulation.",
|
|
"examples": [
|
|
24
|
|
]
|
|
},
|
|
"charge_array": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Charge Array",
|
|
"description": "Hourly charging status (0 for no charging, 1 for charging)."
|
|
},
|
|
"discharge_array": {
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array",
|
|
"title": "Discharge Array",
|
|
"description": "Hourly discharging status (0 for no discharging, 1 for discharging)."
|
|
},
|
|
"discharging_efficiency": {
|
|
"type": "number",
|
|
"title": "Discharging Efficiency",
|
|
"description": "The discharge efficiency as a float.."
|
|
},
|
|
"capacity_wh": {
|
|
"type": "integer",
|
|
"title": "Capacity Wh",
|
|
"description": "Capacity of the EV\u2019s battery in watt-hours."
|
|
},
|
|
"charging_efficiency": {
|
|
"type": "number",
|
|
"title": "Charging Efficiency",
|
|
"description": "Charging efficiency as a float.."
|
|
},
|
|
"max_charge_power_w": {
|
|
"type": "integer",
|
|
"title": "Max Charge Power W",
|
|
"description": "Maximum charging power in watts."
|
|
},
|
|
"soc_wh": {
|
|
"type": "number",
|
|
"title": "Soc Wh",
|
|
"description": "State of charge of the battery in watt-hours at the start of the simulation."
|
|
},
|
|
"initial_soc_percentage": {
|
|
"type": "integer",
|
|
"title": "Initial Soc Percentage",
|
|
"description": "State of charge at the start of the simulation in percentage."
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"type": "object",
|
|
"required": [
|
|
"device_id",
|
|
"hours",
|
|
"charge_array",
|
|
"discharge_array",
|
|
"discharging_efficiency",
|
|
"capacity_wh",
|
|
"charging_efficiency",
|
|
"max_charge_power_w",
|
|
"soc_wh",
|
|
"initial_soc_percentage"
|
|
],
|
|
"title": "ElectricVehicleResult",
|
|
"description": "Result class containing information related to the electric vehicle's charging and discharging behavior."
|
|
},
|
|
"EnergyManagementCommonSettings": {
|
|
"properties": {
|
|
"startup_delay": {
|
|
"type": "number",
|
|
"minimum": 1.0,
|
|
"title": "Startup Delay",
|
|
"description": "Startup delay in seconds for EOS energy management runs.",
|
|
"default": 5
|
|
},
|
|
"interval": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Interval",
|
|
"description": "Intervall in seconds between EOS energy management runs.",
|
|
"examples": [
|
|
"300"
|
|
]
|
|
},
|
|
"mode": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/EnergyManagementMode"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Energy management mode [OPTIMIZATION | PREDICTION].",
|
|
"examples": [
|
|
"OPTIMIZATION",
|
|
"PREDICTION"
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "EnergyManagementCommonSettings",
|
|
"description": "Energy Management Configuration."
|
|
},
|
|
"EnergyManagementMode": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PREDICTION",
|
|
"OPTIMIZATION"
|
|
],
|
|
"title": "EnergyManagementMode",
|
|
"description": "Energy management mode."
|
|
},
|
|
"EnergyManagementPlan": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Id",
|
|
"description": "Unique ID for the energy management plan."
|
|
},
|
|
"generated_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Generated At",
|
|
"description": "Timestamp when the plan was generated."
|
|
},
|
|
"valid_from": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Valid From",
|
|
"description": "Earliest start time of any instruction."
|
|
},
|
|
"valid_until": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Valid Until",
|
|
"description": "Latest end time across all instructions with finite duration; None if all instructions have infinite duration."
|
|
},
|
|
"instructions": {
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PEBCInstruction"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PPBCScheduleInstruction"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PPBCStartInterruptionInstruction"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PPBCEndInterruptionInstruction"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OMBCInstruction"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FRBCInstruction"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/DDBCInstruction"
|
|
}
|
|
],
|
|
"discriminator": {
|
|
"propertyName": "type",
|
|
"mapping": {
|
|
"DDBCInstruction": "#/components/schemas/DDBCInstruction",
|
|
"FRBCInstruction": "#/components/schemas/FRBCInstruction",
|
|
"OMBCInstruction": "#/components/schemas/OMBCInstruction",
|
|
"PEBCInstruction": "#/components/schemas/PEBCInstruction",
|
|
"PPBCEndInterruptionInstruction": "#/components/schemas/PPBCEndInterruptionInstruction",
|
|
"PPBCScheduleInstruction": "#/components/schemas/PPBCScheduleInstruction",
|
|
"PPBCStartInterruptionInstruction": "#/components/schemas/PPBCStartInterruptionInstruction"
|
|
}
|
|
}
|
|
},
|
|
"type": "array",
|
|
"title": "Instructions",
|
|
"description": "List of control instructions for the plan."
|
|
},
|
|
"comment": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Comment",
|
|
"description": "Optional comment or annotation for the plan."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"generated_at",
|
|
"instructions"
|
|
],
|
|
"title": "EnergyManagementPlan",
|
|
"description": "A coordinated energy management plan composed of device control instructions.\n\nAttributes:\n plan_id (ID): Unique identifier for this energy management plan.\n generated_at (DateTime): Timestamp when the plan was generated.\n valid_from (Optional[DateTime]): Earliest start time of any instruction.\n valid_until (Optional[DateTime]): Latest end time across all instructions\n with finite duration; None if all instructions have infinite duration.\n instructions (list[BaseInstruction]): List of control instructions for the plan.\n comment (Optional[str]): Optional comment or annotation for the plan."
|
|
},
|
|
"EnergyMeasurement-Input": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "EnergyMeasurement",
|
|
"title": "Type",
|
|
"default": "EnergyMeasurement"
|
|
},
|
|
"measurement_timestamp": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Measurement Timestamp",
|
|
"description": "Timestamp when energy values were measured."
|
|
},
|
|
"last_reset": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Last Reset",
|
|
"description": "Timestamp when the energy meter's cumulative counter was last reset."
|
|
},
|
|
"values": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/PowerValue"
|
|
},
|
|
"type": "array",
|
|
"title": "Values",
|
|
"description": "Array of measured energy values. Shall contain at least one item and at most one item per 'commodity_quantity' (defined inside the PowerValue)."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"measurement_timestamp",
|
|
"values"
|
|
],
|
|
"title": "EnergyMeasurement",
|
|
"description": "Captures a set of energy meter readouts taken at a specific point in time.\n\nEnergy is defined as the cummulative power per hour as provided by an energy meter.\n\nThis model records multiple energy values (for different commodity quantities)\nalong with the timestamp when the meter readouts were taken, enabling time-series\nanalysis and monitoring of energy consumption or production.\n\nNote: This is an extension to the S2 standard."
|
|
},
|
|
"EnergyMeasurement-Output": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "EnergyMeasurement",
|
|
"title": "Type",
|
|
"default": "EnergyMeasurement"
|
|
},
|
|
"measurement_timestamp": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Measurement Timestamp",
|
|
"description": "Timestamp when energy values were measured."
|
|
},
|
|
"last_reset": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Last Reset",
|
|
"description": "Timestamp when the energy meter's cumulative counter was last reset."
|
|
},
|
|
"values": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/PowerValue"
|
|
},
|
|
"type": "array",
|
|
"title": "Values",
|
|
"description": "Array of measured energy values. Shall contain at least one item and at most one item per 'commodity_quantity' (defined inside the PowerValue)."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"measurement_timestamp",
|
|
"values"
|
|
],
|
|
"title": "EnergyMeasurement",
|
|
"description": "Captures a set of energy meter readouts taken at a specific point in time.\n\nEnergy is defined as the cummulative power per hour as provided by an energy meter.\n\nThis model records multiple energy values (for different commodity quantities)\nalong with the timestamp when the meter readouts were taken, enabling time-series\nanalysis and monitoring of energy consumption or production.\n\nNote: This is an extension to the S2 standard."
|
|
},
|
|
"FRBCActuatorStatus": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "FRBCActuatorStatus",
|
|
"title": "Type",
|
|
"default": "FRBCActuatorStatus"
|
|
},
|
|
"active_operation_mode_id": {
|
|
"type": "string",
|
|
"title": "Active Operation Mode Id",
|
|
"description": "Currently active operation mode ID."
|
|
},
|
|
"operation_mode_factor": {
|
|
"type": "number",
|
|
"maximum": 1.0,
|
|
"minimum": 0.0,
|
|
"title": "Operation Mode Factor",
|
|
"description": "Factor with which the mode is configured (0 to 1)."
|
|
},
|
|
"previous_operation_mode_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Previous Operation Mode Id",
|
|
"description": "Previously active operation mode ID."
|
|
},
|
|
"transition_timestamp": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Transition Timestamp",
|
|
"description": "Timestamp of the last transition between modes."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"active_operation_mode_id",
|
|
"operation_mode_factor"
|
|
],
|
|
"title": "FRBCActuatorStatus",
|
|
"description": "Current status of an FRBC Actuator.\n\nProvides information about the currently active operation mode and transition history.\nUsed to track the current state of the actuator."
|
|
},
|
|
"FRBCEnergyStatus-Input": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "FRBCEnergyStatus",
|
|
"title": "Type",
|
|
"default": "FRBCEnergyStatus"
|
|
},
|
|
"import_total": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/EnergyMeasurement-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Total cumulative imported energy from the energy meter start."
|
|
},
|
|
"export_total": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/EnergyMeasurement-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Total cumulative exported energy from the energy meter start."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "FRBCEnergyStatus",
|
|
"description": "Energy status of an FRBC storage.\n\nNote: This is an extension to the S2 standard."
|
|
},
|
|
"FRBCEnergyStatus-Output": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "FRBCEnergyStatus",
|
|
"title": "Type",
|
|
"default": "FRBCEnergyStatus"
|
|
},
|
|
"import_total": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/EnergyMeasurement-Output"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Total cumulative imported energy from the energy meter start."
|
|
},
|
|
"export_total": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/EnergyMeasurement-Output"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Total cumulative exported energy from the energy meter start."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "FRBCEnergyStatus",
|
|
"description": "Energy status of an FRBC storage.\n\nNote: This is an extension to the S2 standard."
|
|
},
|
|
"FRBCInstruction": {
|
|
"properties": {
|
|
"id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Id",
|
|
"description": "Unique identifier of the instruction in the ResourceManager scope. If not provided and a `resource_id` is passed at instantiation, this will be auto-generated as `{resource_id}@{UUID}`."
|
|
},
|
|
"execution_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Execution Time",
|
|
"description": "Start time of the instruction execution."
|
|
},
|
|
"abnormal_condition": {
|
|
"type": "boolean",
|
|
"title": "Abnormal Condition",
|
|
"description": "Indicates if this is an instruction for abnormal conditions. Defaults to False.",
|
|
"default": false
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "FRBCInstruction",
|
|
"title": "Type",
|
|
"default": "FRBCInstruction"
|
|
},
|
|
"actuator_id": {
|
|
"type": "string",
|
|
"title": "Actuator Id",
|
|
"description": "ID of the actuator this instruction belongs to."
|
|
},
|
|
"operation_mode_id": {
|
|
"type": "string",
|
|
"title": "Operation Mode Id",
|
|
"description": "ID of the operation mode to activate."
|
|
},
|
|
"operation_mode_factor": {
|
|
"type": "number",
|
|
"maximum": 1.0,
|
|
"minimum": 0.0,
|
|
"title": "Operation Mode Factor",
|
|
"description": "Factor for the operation mode configuration (0 to 1)."
|
|
},
|
|
"resource_id": {
|
|
"type": "string",
|
|
"title": "Resource Id",
|
|
"description": "Get the resource identifier component from the instruction's `id`.\n\nAssumes the `id` follows the format `{resource_id}@{UUID}`. Extracts the resource_id part\nof the id by splitting at the last @.\n\nReturns:\n str: The resource identifier prefix of `id`, or an empty string if `id` is None.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"execution_time",
|
|
"actuator_id",
|
|
"operation_mode_id",
|
|
"operation_mode_factor",
|
|
"resource_id"
|
|
],
|
|
"title": "FRBCInstruction",
|
|
"description": "Instruction for Fill Rate Based Control (FRBC).\n\nContains information about when and how to activate a specific operation mode\nfor an actuator. Used to command resources to change their operation at a specified time."
|
|
},
|
|
"FRBCStorageStatus": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "FRBCStorageStatus",
|
|
"title": "Type",
|
|
"default": "FRBCStorageStatus"
|
|
},
|
|
"present_fill_level": {
|
|
"type": "number",
|
|
"title": "Present Fill Level",
|
|
"description": "Current fill level of the storage."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"present_fill_level"
|
|
],
|
|
"title": "FRBCStorageStatus",
|
|
"description": "Current status of an FRBC Storage.\n\nIndicates the current fill level of the storage, which is essential\nfor determining applicable operation modes and control decisions."
|
|
},
|
|
"FRBCTimerStatus": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "FRBCTimerStatus",
|
|
"title": "Type",
|
|
"default": "FRBCTimerStatus"
|
|
},
|
|
"actuator_id": {
|
|
"type": "string",
|
|
"title": "Actuator Id",
|
|
"description": "ID of the actuator the timer belongs to."
|
|
},
|
|
"timer_id": {
|
|
"type": "string",
|
|
"title": "Timer Id",
|
|
"description": "ID of the timer this status refers to."
|
|
},
|
|
"finished_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Finished At",
|
|
"description": "Indicates when the Timer will be finished. If the DateTime is in the future, the timer is not yet finished. If the DateTime is in the past, the timer is finished. If the timer was never started, the value can be an arbitrary DateTimeStamp in the past."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"actuator_id",
|
|
"timer_id",
|
|
"finished_at"
|
|
],
|
|
"title": "FRBCTimerStatus",
|
|
"description": "Current status of an FRBC Timer.\n\nIndicates when the Timer will be finished."
|
|
},
|
|
"FeedInTariffCommonProviderSettings": {
|
|
"properties": {
|
|
"FeedInTariffFixed": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FeedInTariffFixedCommonSettings"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "FeedInTariffFixed settings",
|
|
"examples": [
|
|
null
|
|
]
|
|
},
|
|
"FeedInTariffImport": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FeedInTariffImportCommonSettings"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "FeedInTariffImport settings",
|
|
"examples": [
|
|
null
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "FeedInTariffCommonProviderSettings",
|
|
"description": "Feed In Tariff Prediction Provider Configuration."
|
|
},
|
|
"FeedInTariffCommonSettings-Input": {
|
|
"properties": {
|
|
"provider": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Provider",
|
|
"description": "Feed in tariff provider id of provider to be used.",
|
|
"examples": [
|
|
"FeedInTariffFixed",
|
|
"FeedInTarifImport"
|
|
]
|
|
},
|
|
"provider_settings": {
|
|
"$ref": "#/components/schemas/FeedInTariffCommonProviderSettings",
|
|
"description": "Provider settings",
|
|
"examples": [
|
|
{}
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "FeedInTariffCommonSettings",
|
|
"description": "Feed In Tariff Prediction Configuration."
|
|
},
|
|
"FeedInTariffCommonSettings-Output": {
|
|
"properties": {
|
|
"provider": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Provider",
|
|
"description": "Feed in tariff provider id of provider to be used.",
|
|
"examples": [
|
|
"FeedInTariffFixed",
|
|
"FeedInTarifImport"
|
|
]
|
|
},
|
|
"provider_settings": {
|
|
"$ref": "#/components/schemas/FeedInTariffCommonProviderSettings",
|
|
"description": "Provider settings",
|
|
"examples": [
|
|
{}
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "FeedInTariffCommonSettings",
|
|
"description": "Feed In Tariff Prediction Configuration."
|
|
},
|
|
"FeedInTariffFixedCommonSettings": {
|
|
"properties": {
|
|
"feed_in_tariff_kwh": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number",
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Feed In Tariff Kwh",
|
|
"description": "Electricity price feed in tariff [\u20ac/kWH].",
|
|
"examples": [
|
|
0.078
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "FeedInTariffFixedCommonSettings",
|
|
"description": "Common settings for elecprice fixed price."
|
|
},
|
|
"FeedInTariffImportCommonSettings": {
|
|
"properties": {
|
|
"import_file_path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"format": "path"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Import File Path",
|
|
"description": "Path to the file to import feed in tariff data from.",
|
|
"examples": [
|
|
null,
|
|
"/path/to/feedintariff.json"
|
|
]
|
|
},
|
|
"import_json": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Import Json",
|
|
"description": "JSON string, dictionary of feed in tariff forecast value lists.",
|
|
"examples": [
|
|
"{\"fead_in_tariff_wh\": [0.000078, 0.000078, 0.000023]}"
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "FeedInTariffImportCommonSettings",
|
|
"description": "Common settings for feed in tariff data import from file or JSON string."
|
|
},
|
|
"ForecastResponse": {
|
|
"properties": {
|
|
"temperature": {
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"type": "array",
|
|
"title": "Temperature"
|
|
},
|
|
"pvpower": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Pvpower"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"temperature",
|
|
"pvpower"
|
|
],
|
|
"title": "ForecastResponse"
|
|
},
|
|
"GeneralSettings-Input": {
|
|
"properties": {
|
|
"version": {
|
|
"type": "string",
|
|
"title": "Version",
|
|
"description": "Configuration file version. Used to check compatibility.",
|
|
"default": "0.1.0+dev"
|
|
},
|
|
"data_folder_path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "path"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data Folder Path",
|
|
"description": "Path to EOS data directory.",
|
|
"examples": [
|
|
null,
|
|
"/home/eos/data"
|
|
]
|
|
},
|
|
"data_output_subpath": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "path"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data Output Subpath",
|
|
"description": "Sub-path for the EOS output data directory.",
|
|
"default": "output"
|
|
},
|
|
"latitude": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number",
|
|
"maximum": 90.0,
|
|
"minimum": -90.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Latitude",
|
|
"description": "Latitude in decimal degrees, between -90 and 90, north is positive (ISO 19115) (\u00b0)",
|
|
"default": 52.52
|
|
},
|
|
"longitude": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number",
|
|
"maximum": 180.0,
|
|
"minimum": -180.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Longitude",
|
|
"description": "Longitude in decimal degrees, within -180 to 180 (\u00b0)",
|
|
"default": 13.405
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "GeneralSettings",
|
|
"description": "Settings for common configuration.\n\nGeneral configuration to set directories of cache and output files and system location (latitude\nand longitude).\nValidators ensure each parameter is within a specified range. A computed property, `timezone`,\ndetermines the time zone based on latitude and longitude.\n\nAttributes:\n latitude (Optional[float]): Latitude in degrees, must be between -90 and 90.\n longitude (Optional[float]): Longitude in degrees, must be between -180 and 180.\n\nProperties:\n timezone (Optional[str]): Computed time zone string based on the specified latitude\n and longitude."
|
|
},
|
|
"GeneralSettings-Output": {
|
|
"properties": {
|
|
"version": {
|
|
"type": "string",
|
|
"title": "Version",
|
|
"description": "Configuration file version. Used to check compatibility.",
|
|
"default": "0.1.0+dev"
|
|
},
|
|
"data_folder_path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "path"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data Folder Path",
|
|
"description": "Path to EOS data directory.",
|
|
"examples": [
|
|
null,
|
|
"/home/eos/data"
|
|
]
|
|
},
|
|
"data_output_subpath": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "path"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data Output Subpath",
|
|
"description": "Sub-path for the EOS output data directory.",
|
|
"default": "output"
|
|
},
|
|
"latitude": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number",
|
|
"maximum": 90.0,
|
|
"minimum": -90.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Latitude",
|
|
"description": "Latitude in decimal degrees, between -90 and 90, north is positive (ISO 19115) (\u00b0)",
|
|
"default": 52.52
|
|
},
|
|
"longitude": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number",
|
|
"maximum": 180.0,
|
|
"minimum": -180.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Longitude",
|
|
"description": "Longitude in decimal degrees, within -180 to 180 (\u00b0)",
|
|
"default": 13.405
|
|
},
|
|
"timezone": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Timezone",
|
|
"description": "Compute timezone based on latitude and longitude.",
|
|
"readOnly": true
|
|
},
|
|
"data_output_path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "path"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data Output Path",
|
|
"description": "Compute data_output_path based on data_folder_path.",
|
|
"readOnly": true
|
|
},
|
|
"config_folder_path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "path"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Config Folder Path",
|
|
"description": "Path to EOS configuration directory.",
|
|
"readOnly": true
|
|
},
|
|
"config_file_path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "path"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Config File Path",
|
|
"description": "Path to EOS configuration file.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"timezone",
|
|
"data_output_path",
|
|
"config_folder_path",
|
|
"config_file_path"
|
|
],
|
|
"title": "GeneralSettings",
|
|
"description": "Settings for common configuration.\n\nGeneral configuration to set directories of cache and output files and system location (latitude\nand longitude).\nValidators ensure each parameter is within a specified range. A computed property, `timezone`,\ndetermines the time zone based on latitude and longitude.\n\nAttributes:\n latitude (Optional[float]): Latitude in degrees, must be between -90 and 90.\n longitude (Optional[float]): Longitude in degrees, must be between -180 and 180.\n\nProperties:\n timezone (Optional[str]): Computed time zone string based on the specified latitude\n and longitude."
|
|
},
|
|
"GeneticCommonSettings": {
|
|
"properties": {
|
|
"individuals": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"minimum": 10.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Individuals",
|
|
"description": "Number of individuals (solutions) to generate for the (initial) generation [>= 10]. Defaults to 300.",
|
|
"default": 300,
|
|
"examples": [
|
|
300
|
|
]
|
|
},
|
|
"generations": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"minimum": 10.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Generations",
|
|
"description": "Number of generations to evaluate the optimal solution [>= 10]. Defaults to 400.",
|
|
"default": 400,
|
|
"examples": [
|
|
400
|
|
]
|
|
},
|
|
"seed": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Seed",
|
|
"description": "Fixed seed for genetic algorithm. Defaults to 'None' which means random seed.",
|
|
"examples": [
|
|
null
|
|
]
|
|
},
|
|
"penalties": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Penalties",
|
|
"description": "A dictionary of penalty function parameters consisting of a penalty function parameter name and the associated value.",
|
|
"examples": [
|
|
{
|
|
"ev_soc_miss": 10
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "GeneticCommonSettings",
|
|
"description": "General Genetic Optimization Algorithm Configuration."
|
|
},
|
|
"GeneticEnergyManagementParameters": {
|
|
"properties": {
|
|
"pv_prognose_wh": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Pv Prognose Wh",
|
|
"description": "An array of floats representing the forecasted photovoltaic output in watts for different time intervals."
|
|
},
|
|
"strompreis_euro_pro_wh": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Strompreis Euro Pro Wh",
|
|
"description": "An array of floats representing the electricity price in euros per watt-hour for different time intervals."
|
|
},
|
|
"einspeiseverguetung_euro_pro_wh": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "number"
|
|
}
|
|
],
|
|
"title": "Einspeiseverguetung Euro Pro Wh",
|
|
"description": "A float or array of floats representing the feed-in compensation in euros per watt-hour."
|
|
},
|
|
"preis_euro_pro_wh_akku": {
|
|
"type": "number",
|
|
"title": "Preis Euro Pro Wh Akku",
|
|
"description": "A float representing the cost of battery energy per watt-hour."
|
|
},
|
|
"gesamtlast": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Gesamtlast",
|
|
"description": "An array of floats representing the total load (consumption) in watts for different time intervals."
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"type": "object",
|
|
"required": [
|
|
"pv_prognose_wh",
|
|
"strompreis_euro_pro_wh",
|
|
"einspeiseverguetung_euro_pro_wh",
|
|
"preis_euro_pro_wh_akku",
|
|
"gesamtlast"
|
|
],
|
|
"title": "GeneticEnergyManagementParameters",
|
|
"description": "Encapsulates energy-related forecasts and costs used in GENETIC optimization."
|
|
},
|
|
"GeneticOptimizationParameters": {
|
|
"properties": {
|
|
"ems": {
|
|
"$ref": "#/components/schemas/GeneticEnergyManagementParameters"
|
|
},
|
|
"pv_akku": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SolarPanelBatteryParameters"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"inverter": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/InverterParameters"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"eauto": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ElectricVehicleParameters"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"dishwasher": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/HomeApplianceParameters"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"temperature_forecast": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Temperature Forecast",
|
|
"description": "An array of floats representing the temperature forecast in degrees Celsius for different time intervals."
|
|
},
|
|
"start_solution": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Start Solution",
|
|
"description": "Can be `null` or contain a previous solution (if available)."
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"type": "object",
|
|
"required": [
|
|
"ems",
|
|
"pv_akku",
|
|
"inverter",
|
|
"eauto"
|
|
],
|
|
"title": "GeneticOptimizationParameters",
|
|
"description": "Main parameter class for running the genetic energy optimization.\n\nCollects all model and configuration parameters necessary to run the\noptimization process, such as forecasts, pricing, battery and appliance models."
|
|
},
|
|
"GeneticSimulationResult": {
|
|
"properties": {
|
|
"Last_Wh_pro_Stunde": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Last Wh Pro Stunde",
|
|
"description": "TBD"
|
|
},
|
|
"EAuto_SoC_pro_Stunde": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Eauto Soc Pro Stunde",
|
|
"description": "The state of charge of the EV for each hour."
|
|
},
|
|
"Einnahmen_Euro_pro_Stunde": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Einnahmen Euro Pro Stunde",
|
|
"description": "The revenue from grid feed-in or other sources in euros per hour."
|
|
},
|
|
"Gesamt_Verluste": {
|
|
"type": "number",
|
|
"title": "Gesamt Verluste",
|
|
"description": "The total losses in watt-hours over the entire period."
|
|
},
|
|
"Gesamtbilanz_Euro": {
|
|
"type": "number",
|
|
"title": "Gesamtbilanz Euro",
|
|
"description": "The total balance of revenues minus costs in euros."
|
|
},
|
|
"Gesamteinnahmen_Euro": {
|
|
"type": "number",
|
|
"title": "Gesamteinnahmen Euro",
|
|
"description": "The total revenues in euros."
|
|
},
|
|
"Gesamtkosten_Euro": {
|
|
"type": "number",
|
|
"title": "Gesamtkosten Euro",
|
|
"description": "The total costs in euros."
|
|
},
|
|
"Home_appliance_wh_per_hour": {
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"type": "array",
|
|
"title": "Home Appliance Wh Per Hour",
|
|
"description": "The energy consumption of a household appliance in watt-hours per hour."
|
|
},
|
|
"Kosten_Euro_pro_Stunde": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Kosten Euro Pro Stunde",
|
|
"description": "The costs in euros per hour."
|
|
},
|
|
"Netzbezug_Wh_pro_Stunde": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Netzbezug Wh Pro Stunde",
|
|
"description": "The grid energy drawn in watt-hours per hour."
|
|
},
|
|
"Netzeinspeisung_Wh_pro_Stunde": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Netzeinspeisung Wh Pro Stunde",
|
|
"description": "The energy fed into the grid in watt-hours per hour."
|
|
},
|
|
"Verluste_Pro_Stunde": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Verluste Pro Stunde",
|
|
"description": "The losses in watt-hours per hour."
|
|
},
|
|
"akku_soc_pro_stunde": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Akku Soc Pro Stunde",
|
|
"description": "The state of charge of the battery (not the EV) in percentage per hour."
|
|
},
|
|
"Electricity_price": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Electricity Price",
|
|
"description": "Used Electricity Price, including predictions"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"type": "object",
|
|
"required": [
|
|
"Last_Wh_pro_Stunde",
|
|
"EAuto_SoC_pro_Stunde",
|
|
"Einnahmen_Euro_pro_Stunde",
|
|
"Gesamt_Verluste",
|
|
"Gesamtbilanz_Euro",
|
|
"Gesamteinnahmen_Euro",
|
|
"Gesamtkosten_Euro",
|
|
"Home_appliance_wh_per_hour",
|
|
"Kosten_Euro_pro_Stunde",
|
|
"Netzbezug_Wh_pro_Stunde",
|
|
"Netzeinspeisung_Wh_pro_Stunde",
|
|
"Verluste_Pro_Stunde",
|
|
"akku_soc_pro_stunde",
|
|
"Electricity_price"
|
|
],
|
|
"title": "GeneticSimulationResult",
|
|
"description": "This object contains the results of the simulation and provides insights into various parameters over the entire forecast period."
|
|
},
|
|
"GeneticSolution": {
|
|
"properties": {
|
|
"ac_charge": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Ac Charge",
|
|
"description": "Array with AC charging values as relative power (0.0-1.0), other values set to 0."
|
|
},
|
|
"dc_charge": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Dc Charge",
|
|
"description": "Array with DC charging values as relative power (0-1), other values set to 0."
|
|
},
|
|
"discharge_allowed": {
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array",
|
|
"title": "Discharge Allowed",
|
|
"description": "Array with discharge values (1 for discharge, 0 otherwise)."
|
|
},
|
|
"eautocharge_hours_float": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Eautocharge Hours Float",
|
|
"description": "TBD"
|
|
},
|
|
"result": {
|
|
"$ref": "#/components/schemas/GeneticSimulationResult"
|
|
},
|
|
"eauto_obj": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ElectricVehicleResult"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"start_solution": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Start Solution",
|
|
"description": "An array of binary values (0 or 1) representing a possible starting solution for the simulation."
|
|
},
|
|
"washingstart": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Washingstart",
|
|
"description": "Can be `null` or contain an object representing the start of washing (if applicable)."
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"type": "object",
|
|
"required": [
|
|
"ac_charge",
|
|
"dc_charge",
|
|
"discharge_allowed",
|
|
"eautocharge_hours_float",
|
|
"result",
|
|
"eauto_obj"
|
|
],
|
|
"title": "GeneticSolution",
|
|
"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."
|
|
},
|
|
"GesamtlastRequest": {
|
|
"properties": {
|
|
"year_energy": {
|
|
"type": "number",
|
|
"title": "Year Energy"
|
|
},
|
|
"measured_data": {
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": "array",
|
|
"title": "Measured Data"
|
|
},
|
|
"hours": {
|
|
"type": "integer",
|
|
"title": "Hours"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"year_energy",
|
|
"measured_data",
|
|
"hours"
|
|
],
|
|
"title": "GesamtlastRequest"
|
|
},
|
|
"HTTPValidationError": {
|
|
"properties": {
|
|
"detail": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ValidationError"
|
|
},
|
|
"type": "array",
|
|
"title": "Detail"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "HTTPValidationError"
|
|
},
|
|
"HomeApplianceCommonSettings-Input": {
|
|
"properties": {
|
|
"device_id": {
|
|
"type": "string",
|
|
"title": "Device Id",
|
|
"description": "ID of device",
|
|
"default": "<unknown>",
|
|
"examples": [
|
|
"battery1",
|
|
"ev1",
|
|
"inverter1",
|
|
"dishwasher"
|
|
]
|
|
},
|
|
"consumption_wh": {
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0.0,
|
|
"title": "Consumption Wh",
|
|
"description": "Energy consumption [Wh].",
|
|
"examples": [
|
|
2000
|
|
]
|
|
},
|
|
"duration_h": {
|
|
"type": "integer",
|
|
"maximum": 24.0,
|
|
"exclusiveMinimum": 0.0,
|
|
"title": "Duration H",
|
|
"description": "Usage duration in hours [0 ... 24].",
|
|
"examples": [
|
|
1
|
|
]
|
|
},
|
|
"time_windows": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TimeWindowSequence-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Sequence of allowed time windows. Defaults to optimization general time window.",
|
|
"examples": [
|
|
{
|
|
"windows": [
|
|
{
|
|
"duration": "2 hours",
|
|
"start_time": "10:00"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"consumption_wh",
|
|
"duration_h"
|
|
],
|
|
"title": "HomeApplianceCommonSettings",
|
|
"description": "Home Appliance devices base settings."
|
|
},
|
|
"HomeApplianceCommonSettings-Output": {
|
|
"properties": {
|
|
"device_id": {
|
|
"type": "string",
|
|
"title": "Device Id",
|
|
"description": "ID of device",
|
|
"default": "<unknown>",
|
|
"examples": [
|
|
"battery1",
|
|
"ev1",
|
|
"inverter1",
|
|
"dishwasher"
|
|
]
|
|
},
|
|
"consumption_wh": {
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0.0,
|
|
"title": "Consumption Wh",
|
|
"description": "Energy consumption [Wh].",
|
|
"examples": [
|
|
2000
|
|
]
|
|
},
|
|
"duration_h": {
|
|
"type": "integer",
|
|
"maximum": 24.0,
|
|
"exclusiveMinimum": 0.0,
|
|
"title": "Duration H",
|
|
"description": "Usage duration in hours [0 ... 24].",
|
|
"examples": [
|
|
1
|
|
]
|
|
},
|
|
"time_windows": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TimeWindowSequence-Output"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Sequence of allowed time windows. Defaults to optimization general time window.",
|
|
"examples": [
|
|
{
|
|
"windows": [
|
|
{
|
|
"duration": "2 hours",
|
|
"start_time": "10:00"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"measurement_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Measurement Keys",
|
|
"description": "Measurement keys for the home appliance stati that are measurements.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"consumption_wh",
|
|
"duration_h",
|
|
"measurement_keys"
|
|
],
|
|
"title": "HomeApplianceCommonSettings",
|
|
"description": "Home Appliance devices base settings."
|
|
},
|
|
"HomeApplianceParameters": {
|
|
"properties": {
|
|
"device_id": {
|
|
"type": "string",
|
|
"title": "Device Id",
|
|
"description": "ID of home appliance",
|
|
"examples": [
|
|
"dishwasher"
|
|
]
|
|
},
|
|
"hours": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Hours",
|
|
"description": "Number of prediction hours. Defaults to global config prediction hours.",
|
|
"examples": [
|
|
null
|
|
]
|
|
},
|
|
"consumption_wh": {
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0.0,
|
|
"title": "Consumption Wh",
|
|
"description": "An integer representing the energy consumption of a household device in watt-hours.",
|
|
"examples": [
|
|
2000
|
|
]
|
|
},
|
|
"duration_h": {
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0.0,
|
|
"title": "Duration H",
|
|
"description": "An integer representing the usage duration of a household device in hours.",
|
|
"examples": [
|
|
3
|
|
]
|
|
},
|
|
"time_windows": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TimeWindowSequence-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "List of allowed time windows. Defaults to optimization general time window.",
|
|
"examples": [
|
|
[
|
|
{
|
|
"duration": "2 hours",
|
|
"start_time": "10:00"
|
|
}
|
|
]
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"type": "object",
|
|
"required": [
|
|
"device_id",
|
|
"consumption_wh",
|
|
"duration_h"
|
|
],
|
|
"title": "HomeApplianceParameters",
|
|
"description": "Home Appliance Device Simulation Configuration."
|
|
},
|
|
"InverterCommonSettings-Input": {
|
|
"properties": {
|
|
"device_id": {
|
|
"type": "string",
|
|
"title": "Device Id",
|
|
"description": "ID of device",
|
|
"default": "<unknown>",
|
|
"examples": [
|
|
"battery1",
|
|
"ev1",
|
|
"inverter1",
|
|
"dishwasher"
|
|
]
|
|
},
|
|
"max_power_w": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number",
|
|
"exclusiveMinimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Power W",
|
|
"description": "Maximum power [W].",
|
|
"examples": [
|
|
10000
|
|
]
|
|
},
|
|
"battery_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Battery Id",
|
|
"description": "ID of battery controlled by this inverter.",
|
|
"examples": [
|
|
null,
|
|
"battery1"
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "InverterCommonSettings",
|
|
"description": "Inverter devices base settings."
|
|
},
|
|
"InverterCommonSettings-Output": {
|
|
"properties": {
|
|
"device_id": {
|
|
"type": "string",
|
|
"title": "Device Id",
|
|
"description": "ID of device",
|
|
"default": "<unknown>",
|
|
"examples": [
|
|
"battery1",
|
|
"ev1",
|
|
"inverter1",
|
|
"dishwasher"
|
|
]
|
|
},
|
|
"max_power_w": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number",
|
|
"exclusiveMinimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Power W",
|
|
"description": "Maximum power [W].",
|
|
"examples": [
|
|
10000
|
|
]
|
|
},
|
|
"battery_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Battery Id",
|
|
"description": "ID of battery controlled by this inverter.",
|
|
"examples": [
|
|
null,
|
|
"battery1"
|
|
]
|
|
},
|
|
"measurement_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Measurement Keys",
|
|
"description": "Measurement keys for the inverter stati that are measurements.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"measurement_keys"
|
|
],
|
|
"title": "InverterCommonSettings",
|
|
"description": "Inverter devices base settings."
|
|
},
|
|
"InverterParameters": {
|
|
"properties": {
|
|
"device_id": {
|
|
"type": "string",
|
|
"title": "Device Id",
|
|
"description": "ID of inverter",
|
|
"examples": [
|
|
"inverter1"
|
|
]
|
|
},
|
|
"hours": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Hours",
|
|
"description": "Number of prediction hours. Defaults to global config prediction hours.",
|
|
"examples": [
|
|
null
|
|
]
|
|
},
|
|
"max_power_wh": {
|
|
"type": "number",
|
|
"exclusiveMinimum": 0.0,
|
|
"title": "Max Power Wh",
|
|
"examples": [
|
|
10000
|
|
]
|
|
},
|
|
"battery_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Battery Id",
|
|
"description": "ID of battery",
|
|
"examples": [
|
|
null,
|
|
"battery1"
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"type": "object",
|
|
"required": [
|
|
"device_id",
|
|
"max_power_wh"
|
|
],
|
|
"title": "InverterParameters",
|
|
"description": "Inverter Device Simulation Configuration."
|
|
},
|
|
"LoadAkkudoktorCommonSettings": {
|
|
"properties": {
|
|
"loadakkudoktor_year_energy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Loadakkudoktor Year Energy",
|
|
"description": "Yearly energy consumption (kWh).",
|
|
"examples": [
|
|
40421
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "LoadAkkudoktorCommonSettings",
|
|
"description": "Common settings for load data import from file."
|
|
},
|
|
"LoadCommonProviderSettings": {
|
|
"properties": {
|
|
"LoadAkkudoktor": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/LoadAkkudoktorCommonSettings"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "LoadAkkudoktor settings",
|
|
"examples": [
|
|
null
|
|
]
|
|
},
|
|
"LoadVrm": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/LoadVrmCommonSettings"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "LoadVrm settings",
|
|
"examples": [
|
|
null
|
|
]
|
|
},
|
|
"LoadImport": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/LoadImportCommonSettings"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "LoadImport settings",
|
|
"examples": [
|
|
null
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "LoadCommonProviderSettings",
|
|
"description": "Load Prediction Provider Configuration."
|
|
},
|
|
"LoadCommonSettings-Input": {
|
|
"properties": {
|
|
"provider": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Provider",
|
|
"description": "Load provider id of provider to be used.",
|
|
"examples": [
|
|
"LoadAkkudoktor"
|
|
]
|
|
},
|
|
"provider_settings": {
|
|
"$ref": "#/components/schemas/LoadCommonProviderSettings",
|
|
"description": "Provider settings",
|
|
"examples": [
|
|
{}
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "LoadCommonSettings",
|
|
"description": "Load Prediction Configuration."
|
|
},
|
|
"LoadCommonSettings-Output": {
|
|
"properties": {
|
|
"provider": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Provider",
|
|
"description": "Load provider id of provider to be used.",
|
|
"examples": [
|
|
"LoadAkkudoktor"
|
|
]
|
|
},
|
|
"provider_settings": {
|
|
"$ref": "#/components/schemas/LoadCommonProviderSettings",
|
|
"description": "Provider settings",
|
|
"examples": [
|
|
{}
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "LoadCommonSettings",
|
|
"description": "Load Prediction Configuration."
|
|
},
|
|
"LoadImportCommonSettings": {
|
|
"properties": {
|
|
"import_file_path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"format": "path"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Import File Path",
|
|
"description": "Path to the file to import load data from.",
|
|
"examples": [
|
|
null,
|
|
"/path/to/yearly_load.json"
|
|
]
|
|
},
|
|
"import_json": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Import Json",
|
|
"description": "JSON string, dictionary of load forecast value lists.",
|
|
"examples": [
|
|
"{\"load0_mean\": [676.71, 876.19, 527.13]}"
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "LoadImportCommonSettings",
|
|
"description": "Common settings for load data import from file or JSON string."
|
|
},
|
|
"LoadVrmCommonSettings": {
|
|
"properties": {
|
|
"load_vrm_token": {
|
|
"type": "string",
|
|
"title": "Load Vrm Token",
|
|
"description": "Token for Connecting VRM API",
|
|
"default": "your-token",
|
|
"examples": [
|
|
"your-token"
|
|
]
|
|
},
|
|
"load_vrm_idsite": {
|
|
"type": "integer",
|
|
"title": "Load Vrm Idsite",
|
|
"description": "VRM-Installation-ID",
|
|
"default": 12345,
|
|
"examples": [
|
|
12345
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "LoadVrmCommonSettings",
|
|
"description": "Common settings for VRM API."
|
|
},
|
|
"LoggingCommonSettings-Input": {
|
|
"properties": {
|
|
"console_level": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Console Level",
|
|
"description": "Logging level when logging to console.",
|
|
"examples": [
|
|
"TRACE",
|
|
"DEBUG",
|
|
"INFO",
|
|
"WARNING",
|
|
"ERROR",
|
|
"CRITICAL"
|
|
]
|
|
},
|
|
"file_level": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "File Level",
|
|
"description": "Logging level when logging to file.",
|
|
"examples": [
|
|
"TRACE",
|
|
"DEBUG",
|
|
"INFO",
|
|
"WARNING",
|
|
"ERROR",
|
|
"CRITICAL"
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "LoggingCommonSettings",
|
|
"description": "Logging Configuration."
|
|
},
|
|
"LoggingCommonSettings-Output": {
|
|
"properties": {
|
|
"console_level": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Console Level",
|
|
"description": "Logging level when logging to console.",
|
|
"examples": [
|
|
"TRACE",
|
|
"DEBUG",
|
|
"INFO",
|
|
"WARNING",
|
|
"ERROR",
|
|
"CRITICAL"
|
|
]
|
|
},
|
|
"file_level": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "File Level",
|
|
"description": "Logging level when logging to file.",
|
|
"examples": [
|
|
"TRACE",
|
|
"DEBUG",
|
|
"INFO",
|
|
"WARNING",
|
|
"ERROR",
|
|
"CRITICAL"
|
|
]
|
|
},
|
|
"file_path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "path"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "File Path",
|
|
"description": "Computed log file path based on data output path.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"file_path"
|
|
],
|
|
"title": "LoggingCommonSettings",
|
|
"description": "Logging Configuration."
|
|
},
|
|
"MeasurementCommonSettings-Input": {
|
|
"properties": {
|
|
"load_emr_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Load Emr Keys",
|
|
"description": "The keys of the measurements that are energy meter readings of a load [kWh].",
|
|
"examples": [
|
|
[
|
|
"load0_emr"
|
|
]
|
|
]
|
|
},
|
|
"grid_export_emr_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Grid Export Emr Keys",
|
|
"description": "The keys of the measurements that are energy meter readings of energy export to grid [kWh].",
|
|
"examples": [
|
|
[
|
|
"grid_export_emr"
|
|
]
|
|
]
|
|
},
|
|
"grid_import_emr_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Grid Import Emr Keys",
|
|
"description": "The keys of the measurements that are energy meter readings of energy import from grid [kWh].",
|
|
"examples": [
|
|
[
|
|
"grid_import_emr"
|
|
]
|
|
]
|
|
},
|
|
"pv_production_emr_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Pv Production Emr Keys",
|
|
"description": "The keys of the measurements that are PV production energy meter readings [kWh].",
|
|
"examples": [
|
|
[
|
|
"pv1_emr"
|
|
]
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "MeasurementCommonSettings",
|
|
"description": "Measurement Configuration."
|
|
},
|
|
"MeasurementCommonSettings-Output": {
|
|
"properties": {
|
|
"load_emr_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Load Emr Keys",
|
|
"description": "The keys of the measurements that are energy meter readings of a load [kWh].",
|
|
"examples": [
|
|
[
|
|
"load0_emr"
|
|
]
|
|
]
|
|
},
|
|
"grid_export_emr_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Grid Export Emr Keys",
|
|
"description": "The keys of the measurements that are energy meter readings of energy export to grid [kWh].",
|
|
"examples": [
|
|
[
|
|
"grid_export_emr"
|
|
]
|
|
]
|
|
},
|
|
"grid_import_emr_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Grid Import Emr Keys",
|
|
"description": "The keys of the measurements that are energy meter readings of energy import from grid [kWh].",
|
|
"examples": [
|
|
[
|
|
"grid_import_emr"
|
|
]
|
|
]
|
|
},
|
|
"pv_production_emr_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Pv Production Emr Keys",
|
|
"description": "The keys of the measurements that are PV production energy meter readings [kWh].",
|
|
"examples": [
|
|
[
|
|
"pv1_emr"
|
|
]
|
|
]
|
|
},
|
|
"keys": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"title": "Keys",
|
|
"description": "The keys of the measurements that can be stored.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"keys"
|
|
],
|
|
"title": "MeasurementCommonSettings",
|
|
"description": "Measurement Configuration."
|
|
},
|
|
"OMBCInstruction": {
|
|
"properties": {
|
|
"id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Id",
|
|
"description": "Unique identifier of the instruction in the ResourceManager scope. If not provided and a `resource_id` is passed at instantiation, this will be auto-generated as `{resource_id}@{UUID}`."
|
|
},
|
|
"execution_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Execution Time",
|
|
"description": "Start time of the instruction execution."
|
|
},
|
|
"abnormal_condition": {
|
|
"type": "boolean",
|
|
"title": "Abnormal Condition",
|
|
"description": "Indicates if this is an instruction for abnormal conditions. Defaults to False.",
|
|
"default": false
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "OMBCInstruction",
|
|
"title": "Type",
|
|
"default": "OMBCInstruction"
|
|
},
|
|
"operation_mode_id": {
|
|
"type": "string",
|
|
"title": "Operation Mode Id",
|
|
"description": "ID of the OMBC.OperationMode to activate."
|
|
},
|
|
"operation_mode_factor": {
|
|
"type": "number",
|
|
"maximum": 1.0,
|
|
"minimum": 0.0,
|
|
"title": "Operation Mode Factor",
|
|
"description": "Factor with which the operation mode is configured (0 to 1)."
|
|
},
|
|
"resource_id": {
|
|
"type": "string",
|
|
"title": "Resource Id",
|
|
"description": "Get the resource identifier component from the instruction's `id`.\n\nAssumes the `id` follows the format `{resource_id}@{UUID}`. Extracts the resource_id part\nof the id by splitting at the last @.\n\nReturns:\n str: The resource identifier prefix of `id`, or an empty string if `id` is None.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"execution_time",
|
|
"operation_mode_id",
|
|
"operation_mode_factor",
|
|
"resource_id"
|
|
],
|
|
"title": "OMBCInstruction",
|
|
"description": "Instruction for Operation Mode Based Control (OMBC).\n\nContains information about when and how to activate a specific operation mode.\nUsed to command resources to change their operation at a specified time."
|
|
},
|
|
"OMBCStatus": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "OMBCStatus",
|
|
"title": "Type",
|
|
"default": "OMBCStatus"
|
|
},
|
|
"active_operation_mode_id": {
|
|
"type": "string",
|
|
"title": "Active Operation Mode Id",
|
|
"description": "ID of the currently active operation mode."
|
|
},
|
|
"operation_mode_factor": {
|
|
"type": "number",
|
|
"maximum": 1.0,
|
|
"minimum": 0.0,
|
|
"title": "Operation Mode Factor",
|
|
"description": "Factor with which the operation mode is configured (between 0 and 1)."
|
|
},
|
|
"previous_operation_mode_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Previous Operation Mode Id",
|
|
"description": "ID of the previously active operation mode, if known."
|
|
},
|
|
"transition_timestamp": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Transition Timestamp",
|
|
"description": "Timestamp of transition to the active operation mode, if applicable."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"active_operation_mode_id",
|
|
"operation_mode_factor"
|
|
],
|
|
"title": "OMBCStatus",
|
|
"description": "Reports the current operational status of an Operation Mode Based Control system.\n\nThis model provides real-time status information about an OMBC-controlled device,\nincluding which operation mode is currently active, how it is configured,\nand information about recent mode transitions. It enables monitoring of the\ndevice's operational state and tracking mode transition history."
|
|
},
|
|
"OptimizationCommonSettings": {
|
|
"properties": {
|
|
"horizon_hours": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Horizon Hours",
|
|
"description": "The general time window within which the energy optimization goal shall be achieved [h]. Defaults to 24 hours.",
|
|
"default": 24,
|
|
"examples": [
|
|
24
|
|
]
|
|
},
|
|
"interval": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"maximum": 3600.0,
|
|
"minimum": 900.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Interval",
|
|
"description": "The optimization interval [sec].",
|
|
"default": 3600,
|
|
"examples": [
|
|
3600,
|
|
900
|
|
]
|
|
},
|
|
"genetic": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/GeneticCommonSettings"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Genetic optimization algorithm configuration.",
|
|
"examples": [
|
|
{
|
|
"individuals": 400,
|
|
"penalties": {
|
|
"ev_soc_miss": 10
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "OptimizationCommonSettings",
|
|
"description": "General Optimization Configuration."
|
|
},
|
|
"OptimizationSolution": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Id",
|
|
"description": "Unique ID for the optimization solution."
|
|
},
|
|
"generated_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Generated At",
|
|
"description": "Timestamp when the solution was generated."
|
|
},
|
|
"comment": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Comment",
|
|
"description": "Optional comment or annotation for the solution."
|
|
},
|
|
"valid_from": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Valid From",
|
|
"description": "Start time of the optimization solution."
|
|
},
|
|
"valid_until": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Valid Until",
|
|
"description": "End time of the optimization solution."
|
|
},
|
|
"total_losses_energy_wh": {
|
|
"type": "number",
|
|
"title": "Total Losses Energy Wh",
|
|
"description": "The total losses in watt-hours over the entire period."
|
|
},
|
|
"total_revenues_amt": {
|
|
"type": "number",
|
|
"title": "Total Revenues Amt",
|
|
"description": "The total revenues [money amount]."
|
|
},
|
|
"total_costs_amt": {
|
|
"type": "number",
|
|
"title": "Total Costs Amt",
|
|
"description": "The total costs [money amount]."
|
|
},
|
|
"data": {
|
|
"$ref": "#/components/schemas/PydanticDateTimeDataFrame",
|
|
"description": "Datetime data frame with time series optimization data per optimization interval:- load_energy_wh: Load of all energy consumers in wh- grid_energy_wh: Grid energy feed in (negative) or consumption (positive) in wh- pv_prediction_energy_wh: PV energy prediction (positive) in wh- elec_price_prediction_amt_kwh: Electricity price prediction in money per kwh- costs_amt: Costs in money amount- revenue_amt: Revenue in money amount- losses_energy_wh: Energy losses in wh- <device-id>_operation_mode_id: Operation mode id of the device.- <device-id>_operation_mode_factor: Operation mode factor of the device.- <device-id>_soc_factor: State of charge of a battery/ electric vehicle device as factor of total capacity.- <device-id>_energy_wh: Energy consumption (positive) of a device in wh."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"generated_at",
|
|
"total_losses_energy_wh",
|
|
"total_revenues_amt",
|
|
"total_costs_amt",
|
|
"data"
|
|
],
|
|
"title": "OptimizationSolution",
|
|
"description": "General Optimization Solution."
|
|
},
|
|
"PEBCInstruction": {
|
|
"properties": {
|
|
"id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Id",
|
|
"description": "Unique identifier of the instruction in the ResourceManager scope. If not provided and a `resource_id` is passed at instantiation, this will be auto-generated as `{resource_id}@{UUID}`."
|
|
},
|
|
"execution_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Execution Time",
|
|
"description": "Start time of the instruction execution."
|
|
},
|
|
"abnormal_condition": {
|
|
"type": "boolean",
|
|
"title": "Abnormal Condition",
|
|
"description": "Indicates if this is an instruction for abnormal conditions. Defaults to False.",
|
|
"default": false
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "PEBCInstruction",
|
|
"title": "Type",
|
|
"default": "PEBCInstruction"
|
|
},
|
|
"power_constraints_id": {
|
|
"type": "string",
|
|
"title": "Power Constraints Id",
|
|
"description": "ID of the associated PEBC.PowerConstraints."
|
|
},
|
|
"power_envelopes": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/PEBCPowerEnvelope"
|
|
},
|
|
"type": "array",
|
|
"minItems": 1,
|
|
"title": "Power Envelopes",
|
|
"description": "List of PowerEnvelopes to follow. One per CommodityQuantity, max one per type."
|
|
},
|
|
"resource_id": {
|
|
"type": "string",
|
|
"title": "Resource Id",
|
|
"description": "Get the resource identifier component from the instruction's `id`.\n\nAssumes the `id` follows the format `{resource_id}@{UUID}`. Extracts the resource_id part\nof the id by splitting at the last @.\n\nReturns:\n str: The resource identifier prefix of `id`, or an empty string if `id` is None.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"execution_time",
|
|
"power_constraints_id",
|
|
"power_envelopes",
|
|
"resource_id"
|
|
],
|
|
"title": "PEBCInstruction",
|
|
"description": "Represents a control instruction for Power Envelope Based Control.\n\nThis model defines a complete instruction for controlling a device using power\nenvelopes. It specifies when the instruction should be executed, which power\nconstraints apply, and the specific power envelopes to follow. It supports\nmultiple power envelopes for different commodity quantities."
|
|
},
|
|
"PEBCPowerEnvelope": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Id",
|
|
"description": "Unique identifier of this PEBC.PowerEnvelope, scoped to the ResourceManager."
|
|
},
|
|
"commodity_quantity": {
|
|
"$ref": "#/components/schemas/CommodityQuantity",
|
|
"description": "Type of power quantity the envelope applies to."
|
|
},
|
|
"power_envelope_elements": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/PEBCPowerEnvelopeElement"
|
|
},
|
|
"type": "array",
|
|
"minItems": 1,
|
|
"title": "Power Envelope Elements",
|
|
"description": "Chronologically ordered list of PowerEnvelopeElements. Defines how power should be constrained over time."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"commodity_quantity",
|
|
"power_envelope_elements"
|
|
],
|
|
"title": "PEBCPowerEnvelope",
|
|
"description": "Defines a complete power envelope constraint for a specific commodity quantity.\n\nThis model specifies a time-series of power limits (upper and lower bounds) that\na device must operate within. The power envelope consists of sequential elements,\neach defining constraints for a specific duration, creating a complete time-varying\noperational boundary for the device."
|
|
},
|
|
"PEBCPowerEnvelopeElement": {
|
|
"properties": {
|
|
"duration": {
|
|
"type": "string",
|
|
"format": "duration",
|
|
"title": "Duration",
|
|
"description": "Duration of this power envelope element."
|
|
},
|
|
"upper_limit": {
|
|
"type": "number",
|
|
"title": "Upper Limit",
|
|
"description": "Upper power limit for the given commodity_quantity. Shall match PEBC.AllowedLimitRange with limit_type UPPER_LIMIT."
|
|
},
|
|
"lower_limit": {
|
|
"type": "number",
|
|
"title": "Lower Limit",
|
|
"description": "Lower power limit for the given commodity_quantity. Shall match PEBC.AllowedLimitRange with limit_type LOWER_LIMIT."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"duration",
|
|
"upper_limit",
|
|
"lower_limit"
|
|
],
|
|
"title": "PEBCPowerEnvelopeElement",
|
|
"description": "Defines a segment of a power envelope for a specific duration.\n\nThis model specifies the upper and lower power limits for a specific time duration,\nforming part of a complete power envelope. A sequence of these elements creates\na time-varying power envelope that constrains device power consumption or production."
|
|
},
|
|
"PPBCEndInterruptionInstruction": {
|
|
"properties": {
|
|
"id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Id",
|
|
"description": "Unique identifier of the instruction in the ResourceManager scope. If not provided and a `resource_id` is passed at instantiation, this will be auto-generated as `{resource_id}@{UUID}`."
|
|
},
|
|
"execution_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Execution Time",
|
|
"description": "Start time of the instruction execution."
|
|
},
|
|
"abnormal_condition": {
|
|
"type": "boolean",
|
|
"title": "Abnormal Condition",
|
|
"description": "Indicates if this is an instruction for abnormal conditions. Defaults to False.",
|
|
"default": false
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "PPBCEndInterruptionInstruction",
|
|
"title": "Type",
|
|
"default": "PPBCEndInterruptionInstruction"
|
|
},
|
|
"power_profile_id": {
|
|
"type": "string",
|
|
"title": "Power Profile Id",
|
|
"description": "ID of the PowerProfileDefinition related to the ended interruption."
|
|
},
|
|
"sequence_container_id": {
|
|
"type": "string",
|
|
"title": "Sequence Container Id",
|
|
"description": "ID of the container containing the sequence."
|
|
},
|
|
"power_sequence_id": {
|
|
"type": "string",
|
|
"title": "Power Sequence Id",
|
|
"description": "ID of the PowerSequence for which the interruption ends."
|
|
},
|
|
"resource_id": {
|
|
"type": "string",
|
|
"title": "Resource Id",
|
|
"description": "Get the resource identifier component from the instruction's `id`.\n\nAssumes the `id` follows the format `{resource_id}@{UUID}`. Extracts the resource_id part\nof the id by splitting at the last @.\n\nReturns:\n str: The resource identifier prefix of `id`, or an empty string if `id` is None.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"execution_time",
|
|
"power_profile_id",
|
|
"sequence_container_id",
|
|
"power_sequence_id",
|
|
"resource_id"
|
|
],
|
|
"title": "PPBCEndInterruptionInstruction",
|
|
"description": "Represents an instruction to resume execution of a previously interrupted power sequence.\n\nThis model defines a control instruction that ends an interruption and resumes\nexecution of a previously interrupted power sequence. It complements the start\ninterruption instruction, enabling the complete interruption-resumption cycle\nfor flexible sequence execution control."
|
|
},
|
|
"PPBCPowerProfileStatus-Input": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "PPBCPowerProfileStatus",
|
|
"title": "Type",
|
|
"default": "PPBCPowerProfileStatus"
|
|
},
|
|
"sequence_container_status": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/PPBCPowerSequenceContainerStatus"
|
|
},
|
|
"type": "array",
|
|
"title": "Sequence Container Status",
|
|
"description": "Status list for all sequence containers in the PowerProfileDefinition."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"sequence_container_status"
|
|
],
|
|
"title": "PPBCPowerProfileStatus",
|
|
"description": "Reports the current status of a power profile execution.\n\nThis model provides comprehensive status information for all sequence containers\nin a power profile definition, enabling monitoring of profile execution progress.\nIt tracks which sequences have been selected and their current execution status."
|
|
},
|
|
"PPBCPowerProfileStatus-Output": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "PPBCPowerProfileStatus",
|
|
"title": "Type",
|
|
"default": "PPBCPowerProfileStatus"
|
|
},
|
|
"sequence_container_status": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/PPBCPowerSequenceContainerStatus"
|
|
},
|
|
"type": "array",
|
|
"title": "Sequence Container Status",
|
|
"description": "Status list for all sequence containers in the PowerProfileDefinition."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"sequence_container_status"
|
|
],
|
|
"title": "PPBCPowerProfileStatus",
|
|
"description": "Reports the current status of a power profile execution.\n\nThis model provides comprehensive status information for all sequence containers\nin a power profile definition, enabling monitoring of profile execution progress.\nIt tracks which sequences have been selected and their current execution status."
|
|
},
|
|
"PPBCPowerSequenceContainerStatus": {
|
|
"properties": {
|
|
"power_profile_id": {
|
|
"type": "string",
|
|
"title": "Power Profile Id",
|
|
"description": "ID of the related PowerProfileDefinition."
|
|
},
|
|
"sequence_container_id": {
|
|
"type": "string",
|
|
"title": "Sequence Container Id",
|
|
"description": "ID of the PowerSequenceContainer being reported on."
|
|
},
|
|
"selected_sequence_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Selected Sequence Id",
|
|
"description": "ID of the selected PowerSequence, if any."
|
|
},
|
|
"progress": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "duration"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Progress",
|
|
"description": "Elapsed time since the selected sequence started, if applicable."
|
|
},
|
|
"status": {
|
|
"$ref": "#/components/schemas/PPBCPowerSequenceStatus",
|
|
"description": "Status of the selected PowerSequence."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"power_profile_id",
|
|
"sequence_container_id",
|
|
"status"
|
|
],
|
|
"title": "PPBCPowerSequenceContainerStatus",
|
|
"description": "Reports the status of a specific power sequence container execution.\n\nThis model provides detailed status information for a single sequence container,\nincluding which sequence was selected, the current execution progress, and the\noperational status. It enables fine-grained monitoring of sequence execution\nwithin the broader power profile."
|
|
},
|
|
"PPBCPowerSequenceStatus": {
|
|
"type": "string",
|
|
"enum": [
|
|
"NOT_SCHEDULED",
|
|
"SCHEDULED",
|
|
"EXECUTING",
|
|
"INTERRUPTED",
|
|
"FINISHED",
|
|
"ABORTED"
|
|
],
|
|
"title": "PPBCPowerSequenceStatus",
|
|
"description": "Enumeration of status values for Power Profile Based Control sequences."
|
|
},
|
|
"PPBCScheduleInstruction": {
|
|
"properties": {
|
|
"id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Id",
|
|
"description": "Unique identifier of the instruction in the ResourceManager scope. If not provided and a `resource_id` is passed at instantiation, this will be auto-generated as `{resource_id}@{UUID}`."
|
|
},
|
|
"execution_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Execution Time",
|
|
"description": "Start time of the instruction execution."
|
|
},
|
|
"abnormal_condition": {
|
|
"type": "boolean",
|
|
"title": "Abnormal Condition",
|
|
"description": "Indicates if this is an instruction for abnormal conditions. Defaults to False.",
|
|
"default": false
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "PPBCScheduleInstruction",
|
|
"title": "Type",
|
|
"default": "PPBCScheduleInstruction"
|
|
},
|
|
"power_profile_id": {
|
|
"type": "string",
|
|
"title": "Power Profile Id",
|
|
"description": "ID of the PowerProfileDefinition being scheduled."
|
|
},
|
|
"sequence_container_id": {
|
|
"type": "string",
|
|
"title": "Sequence Container Id",
|
|
"description": "ID of the container with the selected sequence."
|
|
},
|
|
"power_sequence_id": {
|
|
"type": "string",
|
|
"title": "Power Sequence Id",
|
|
"description": "ID of the selected PowerSequence."
|
|
},
|
|
"resource_id": {
|
|
"type": "string",
|
|
"title": "Resource Id",
|
|
"description": "Get the resource identifier component from the instruction's `id`.\n\nAssumes the `id` follows the format `{resource_id}@{UUID}`. Extracts the resource_id part\nof the id by splitting at the last @.\n\nReturns:\n str: The resource identifier prefix of `id`, or an empty string if `id` is None.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"execution_time",
|
|
"power_profile_id",
|
|
"sequence_container_id",
|
|
"power_sequence_id",
|
|
"resource_id"
|
|
],
|
|
"title": "PPBCScheduleInstruction",
|
|
"description": "Represents an instruction to schedule execution of a specific power sequence.\n\nThis model defines a control instruction that schedules the execution of a\nselected power sequence from a power profile. It specifies which sequence\nhas been selected and when it should begin execution, enabling precise control\nof device power behavior according to the predefined sequence."
|
|
},
|
|
"PPBCStartInterruptionInstruction": {
|
|
"properties": {
|
|
"id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Id",
|
|
"description": "Unique identifier of the instruction in the ResourceManager scope. If not provided and a `resource_id` is passed at instantiation, this will be auto-generated as `{resource_id}@{UUID}`."
|
|
},
|
|
"execution_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Execution Time",
|
|
"description": "Start time of the instruction execution."
|
|
},
|
|
"abnormal_condition": {
|
|
"type": "boolean",
|
|
"title": "Abnormal Condition",
|
|
"description": "Indicates if this is an instruction for abnormal conditions. Defaults to False.",
|
|
"default": false
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "PPBCStartInterruptionInstruction",
|
|
"title": "Type",
|
|
"default": "PPBCStartInterruptionInstruction"
|
|
},
|
|
"power_profile_id": {
|
|
"type": "string",
|
|
"title": "Power Profile Id",
|
|
"description": "ID of the PowerProfileDefinition whose sequence is being interrupted."
|
|
},
|
|
"sequence_container_id": {
|
|
"type": "string",
|
|
"title": "Sequence Container Id",
|
|
"description": "ID of the container containing the sequence."
|
|
},
|
|
"power_sequence_id": {
|
|
"type": "string",
|
|
"title": "Power Sequence Id",
|
|
"description": "ID of the PowerSequence to be interrupted."
|
|
},
|
|
"resource_id": {
|
|
"type": "string",
|
|
"title": "Resource Id",
|
|
"description": "Get the resource identifier component from the instruction's `id`.\n\nAssumes the `id` follows the format `{resource_id}@{UUID}`. Extracts the resource_id part\nof the id by splitting at the last @.\n\nReturns:\n str: The resource identifier prefix of `id`, or an empty string if `id` is None.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"execution_time",
|
|
"power_profile_id",
|
|
"sequence_container_id",
|
|
"power_sequence_id",
|
|
"resource_id"
|
|
],
|
|
"title": "PPBCStartInterruptionInstruction",
|
|
"description": "Represents an instruction to interrupt execution of a running power sequence.\n\nThis model defines a control instruction that interrupts the execution of an\nactive power sequence. It enables dynamic control over sequence execution,\nallowing temporary suspension of a sequence in response to changing system conditions\nor requirements, particularly for sequences marked as interruptible."
|
|
},
|
|
"PVForecastCommonProviderSettings": {
|
|
"properties": {
|
|
"PVForecastImport": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PVForecastImportCommonSettings"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "PVForecastImport settings",
|
|
"examples": [
|
|
null
|
|
]
|
|
},
|
|
"PVForecastVrm": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PVForecastVrmCommonSettings"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "PVForecastVrm settings",
|
|
"examples": [
|
|
null
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "PVForecastCommonProviderSettings",
|
|
"description": "PV Forecast Provider Configuration."
|
|
},
|
|
"PVForecastCommonSettings-Input": {
|
|
"properties": {
|
|
"provider": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Provider",
|
|
"description": "PVForecast provider id of provider to be used.",
|
|
"examples": [
|
|
"PVForecastAkkudoktor"
|
|
]
|
|
},
|
|
"provider_settings": {
|
|
"$ref": "#/components/schemas/PVForecastCommonProviderSettings",
|
|
"description": "Provider settings",
|
|
"examples": [
|
|
{}
|
|
]
|
|
},
|
|
"planes": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/PVForecastPlaneSetting"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Planes",
|
|
"description": "Plane configuration.",
|
|
"examples": [
|
|
[
|
|
{
|
|
"inverter_paco": 6000,
|
|
"loss": 14.0,
|
|
"modules_per_string": 20,
|
|
"mountingplace": "free",
|
|
"optimal_surface_tilt": false,
|
|
"optimalangles": false,
|
|
"peakpower": 5.0,
|
|
"pvtechchoice": "crystSi",
|
|
"strings_per_inverter": 2,
|
|
"surface_azimuth": 180.0,
|
|
"surface_tilt": 10.0,
|
|
"trackingtype": 0,
|
|
"userhorizon": [
|
|
10.0,
|
|
20.0,
|
|
30.0
|
|
]
|
|
},
|
|
{
|
|
"inverter_paco": 4000,
|
|
"loss": 14.0,
|
|
"modules_per_string": 20,
|
|
"mountingplace": "free",
|
|
"optimal_surface_tilt": false,
|
|
"optimalangles": false,
|
|
"peakpower": 3.5,
|
|
"pvtechchoice": "crystSi",
|
|
"strings_per_inverter": 2,
|
|
"surface_azimuth": 90.0,
|
|
"surface_tilt": 20.0,
|
|
"trackingtype": 1,
|
|
"userhorizon": [
|
|
5.0,
|
|
15.0,
|
|
25.0
|
|
]
|
|
}
|
|
]
|
|
]
|
|
},
|
|
"max_planes": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Planes",
|
|
"description": "Maximum number of planes that can be set",
|
|
"default": 0,
|
|
"examples": [
|
|
1,
|
|
2
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "PVForecastCommonSettings",
|
|
"description": "PV Forecast Configuration."
|
|
},
|
|
"PVForecastCommonSettings-Output": {
|
|
"properties": {
|
|
"provider": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Provider",
|
|
"description": "PVForecast provider id of provider to be used.",
|
|
"examples": [
|
|
"PVForecastAkkudoktor"
|
|
]
|
|
},
|
|
"provider_settings": {
|
|
"$ref": "#/components/schemas/PVForecastCommonProviderSettings",
|
|
"description": "Provider settings",
|
|
"examples": [
|
|
{}
|
|
]
|
|
},
|
|
"planes": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/PVForecastPlaneSetting"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Planes",
|
|
"description": "Plane configuration.",
|
|
"examples": [
|
|
[
|
|
{
|
|
"inverter_paco": 6000,
|
|
"loss": 14.0,
|
|
"modules_per_string": 20,
|
|
"mountingplace": "free",
|
|
"optimal_surface_tilt": false,
|
|
"optimalangles": false,
|
|
"peakpower": 5.0,
|
|
"pvtechchoice": "crystSi",
|
|
"strings_per_inverter": 2,
|
|
"surface_azimuth": 180.0,
|
|
"surface_tilt": 10.0,
|
|
"trackingtype": 0,
|
|
"userhorizon": [
|
|
10.0,
|
|
20.0,
|
|
30.0
|
|
]
|
|
},
|
|
{
|
|
"inverter_paco": 4000,
|
|
"loss": 14.0,
|
|
"modules_per_string": 20,
|
|
"mountingplace": "free",
|
|
"optimal_surface_tilt": false,
|
|
"optimalangles": false,
|
|
"peakpower": 3.5,
|
|
"pvtechchoice": "crystSi",
|
|
"strings_per_inverter": 2,
|
|
"surface_azimuth": 90.0,
|
|
"surface_tilt": 20.0,
|
|
"trackingtype": 1,
|
|
"userhorizon": [
|
|
5.0,
|
|
15.0,
|
|
25.0
|
|
]
|
|
}
|
|
]
|
|
]
|
|
},
|
|
"max_planes": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Planes",
|
|
"description": "Maximum number of planes that can be set",
|
|
"default": 0,
|
|
"examples": [
|
|
1,
|
|
2
|
|
]
|
|
},
|
|
"planes_peakpower": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Planes Peakpower",
|
|
"description": "Compute a list of the peak power per active planes.",
|
|
"readOnly": true
|
|
},
|
|
"planes_azimuth": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Planes Azimuth",
|
|
"description": "Compute a list of the azimuths per active planes.",
|
|
"readOnly": true
|
|
},
|
|
"planes_tilt": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"title": "Planes Tilt",
|
|
"description": "Compute a list of the tilts per active planes.",
|
|
"readOnly": true
|
|
},
|
|
"planes_userhorizon": {
|
|
"title": "Planes Userhorizon",
|
|
"description": "Compute a list of the user horizon per active planes.",
|
|
"readOnly": true
|
|
},
|
|
"planes_inverter_paco": {
|
|
"title": "Planes Inverter Paco",
|
|
"description": "Compute a list of the maximum power rating of the inverter per active planes.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"planes_peakpower",
|
|
"planes_azimuth",
|
|
"planes_tilt",
|
|
"planes_userhorizon",
|
|
"planes_inverter_paco"
|
|
],
|
|
"title": "PVForecastCommonSettings",
|
|
"description": "PV Forecast Configuration."
|
|
},
|
|
"PVForecastImportCommonSettings": {
|
|
"properties": {
|
|
"import_file_path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"format": "path"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Import File Path",
|
|
"description": "Path to the file to import PV forecast data from.",
|
|
"examples": [
|
|
null,
|
|
"/path/to/pvforecast.json"
|
|
]
|
|
},
|
|
"import_json": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Import Json",
|
|
"description": "JSON string, dictionary of PV forecast value lists.",
|
|
"examples": [
|
|
"{\"pvforecast_ac_power\": [0, 8.05, 352.91]}"
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "PVForecastImportCommonSettings",
|
|
"description": "Common settings for pvforecast data import from file or JSON string."
|
|
},
|
|
"PVForecastPlaneSetting": {
|
|
"properties": {
|
|
"surface_tilt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number",
|
|
"maximum": 90.0,
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Surface Tilt",
|
|
"description": "Tilt angle from horizontal plane. Ignored for two-axis tracking.",
|
|
"default": 30.0,
|
|
"examples": [
|
|
10.0,
|
|
20.0
|
|
]
|
|
},
|
|
"surface_azimuth": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number",
|
|
"maximum": 360.0,
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Surface Azimuth",
|
|
"description": "Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270).",
|
|
"default": 180.0,
|
|
"examples": [
|
|
180.0,
|
|
90.0
|
|
]
|
|
},
|
|
"userhorizon": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Userhorizon",
|
|
"description": "Elevation of horizon in degrees, at equally spaced azimuth clockwise from north.",
|
|
"examples": [
|
|
[
|
|
10.0,
|
|
20.0,
|
|
30.0
|
|
],
|
|
[
|
|
5.0,
|
|
15.0,
|
|
25.0
|
|
]
|
|
]
|
|
},
|
|
"peakpower": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Peakpower",
|
|
"description": "Nominal power of PV system in kW.",
|
|
"examples": [
|
|
5.0,
|
|
3.5
|
|
]
|
|
},
|
|
"pvtechchoice": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Pvtechchoice",
|
|
"description": "PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'.",
|
|
"default": "crystSi"
|
|
},
|
|
"mountingplace": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Mountingplace",
|
|
"description": "Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated.",
|
|
"default": "free"
|
|
},
|
|
"loss": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Loss",
|
|
"description": "Sum of PV system losses in percent",
|
|
"default": 14.0
|
|
},
|
|
"trackingtype": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"maximum": 5.0,
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Trackingtype",
|
|
"description": "Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south.",
|
|
"examples": [
|
|
0,
|
|
1,
|
|
2,
|
|
3,
|
|
4,
|
|
5
|
|
]
|
|
},
|
|
"optimal_surface_tilt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Optimal Surface Tilt",
|
|
"description": "Calculate the optimum tilt angle. Ignored for two-axis tracking.",
|
|
"default": false,
|
|
"examples": [
|
|
false
|
|
]
|
|
},
|
|
"optimalangles": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Optimalangles",
|
|
"description": "Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking.",
|
|
"default": false,
|
|
"examples": [
|
|
false
|
|
]
|
|
},
|
|
"albedo": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Albedo",
|
|
"description": "Proportion of the light hitting the ground that it reflects back.",
|
|
"examples": [
|
|
null
|
|
]
|
|
},
|
|
"module_model": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Module Model",
|
|
"description": "Model of the PV modules of this plane.",
|
|
"examples": [
|
|
null
|
|
]
|
|
},
|
|
"inverter_model": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Inverter Model",
|
|
"description": "Model of the inverter of this plane.",
|
|
"examples": [
|
|
null
|
|
]
|
|
},
|
|
"inverter_paco": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Inverter Paco",
|
|
"description": "AC power rating of the inverter [W].",
|
|
"examples": [
|
|
6000,
|
|
4000
|
|
]
|
|
},
|
|
"modules_per_string": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Modules Per String",
|
|
"description": "Number of the PV modules of the strings of this plane.",
|
|
"examples": [
|
|
20
|
|
]
|
|
},
|
|
"strings_per_inverter": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Strings Per Inverter",
|
|
"description": "Number of the strings of the inverter of this plane.",
|
|
"examples": [
|
|
2
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "PVForecastPlaneSetting",
|
|
"description": "PV Forecast Plane Configuration."
|
|
},
|
|
"PVForecastVrmCommonSettings": {
|
|
"properties": {
|
|
"pvforecast_vrm_token": {
|
|
"type": "string",
|
|
"title": "Pvforecast Vrm Token",
|
|
"description": "Token for Connecting VRM API",
|
|
"default": "your-token",
|
|
"examples": [
|
|
"your-token"
|
|
]
|
|
},
|
|
"pvforecast_vrm_idsite": {
|
|
"type": "integer",
|
|
"title": "Pvforecast Vrm Idsite",
|
|
"description": "VRM-Installation-ID",
|
|
"default": 12345,
|
|
"examples": [
|
|
12345
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "PVForecastVrmCommonSettings",
|
|
"description": "Common settings for VRM API."
|
|
},
|
|
"PowerMeasurement-Input": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "PowerMeasurement",
|
|
"title": "Type",
|
|
"default": "PowerMeasurement"
|
|
},
|
|
"measurement_timestamp": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Measurement Timestamp",
|
|
"description": "Timestamp when PowerValues were measured."
|
|
},
|
|
"values": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/PowerValue"
|
|
},
|
|
"type": "array",
|
|
"title": "Values",
|
|
"description": "Array of measured PowerValues. Shall contain at least one item and at most one item per 'commodity_quantity' (defined inside the PowerValue)."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"measurement_timestamp",
|
|
"values"
|
|
],
|
|
"title": "PowerMeasurement",
|
|
"description": "Captures a set of power measurements taken at a specific point in time.\n\nThis model records multiple power values (for different commodity quantities)\nalong with the timestamp when the measurements were taken, enabling time-series\nanalysis and monitoring of power consumption or production."
|
|
},
|
|
"PowerMeasurement-Output": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "PowerMeasurement",
|
|
"title": "Type",
|
|
"default": "PowerMeasurement"
|
|
},
|
|
"measurement_timestamp": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Measurement Timestamp",
|
|
"description": "Timestamp when PowerValues were measured."
|
|
},
|
|
"values": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/PowerValue"
|
|
},
|
|
"type": "array",
|
|
"title": "Values",
|
|
"description": "Array of measured PowerValues. Shall contain at least one item and at most one item per 'commodity_quantity' (defined inside the PowerValue)."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"measurement_timestamp",
|
|
"values"
|
|
],
|
|
"title": "PowerMeasurement",
|
|
"description": "Captures a set of power measurements taken at a specific point in time.\n\nThis model records multiple power values (for different commodity quantities)\nalong with the timestamp when the measurements were taken, enabling time-series\nanalysis and monitoring of power consumption or production."
|
|
},
|
|
"PowerValue": {
|
|
"properties": {
|
|
"commodity_quantity": {
|
|
"$ref": "#/components/schemas/CommodityQuantity",
|
|
"description": "The power quantity the value refers to."
|
|
},
|
|
"value": {
|
|
"type": "number",
|
|
"title": "Value",
|
|
"description": "Power value expressed in the unit associated with the CommodityQuantity."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"commodity_quantity",
|
|
"value"
|
|
],
|
|
"title": "PowerValue",
|
|
"description": "Represents a specific power value measurement with its associated commodity quantity.\n\nThis class links a numerical power value to a specific type of power quantity (such as\nactive power, reactive power, etc.) and its unit of measurement."
|
|
},
|
|
"PredictionCommonSettings": {
|
|
"properties": {
|
|
"hours": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Hours",
|
|
"description": "Number of hours into the future for predictions",
|
|
"default": 48
|
|
},
|
|
"historic_hours": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"minimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Historic Hours",
|
|
"description": "Number of hours into the past for historical predictions data",
|
|
"default": 48
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "PredictionCommonSettings",
|
|
"description": "General Prediction Configuration.\n\nThis class provides configuration for prediction settings, allowing users to specify\nparameters such as the forecast duration (in hours).\nValidators ensure each parameter is within a specified range.\n\nAttributes:\n hours (Optional[int]): Number of hours into the future for predictions.\n Must be non-negative.\n historic_hours (Optional[int]): Number of hours into the past for historical data.\n Must be non-negative.\n\nValidators:\n validate_hours (int): Ensures `hours` is a non-negative integer.\n validate_historic_hours (int): Ensures `historic_hours` is a non-negative integer."
|
|
},
|
|
"PydanticDateTimeData": {
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
}
|
|
]
|
|
},
|
|
"type": "object",
|
|
"title": "PydanticDateTimeData",
|
|
"description": "Pydantic model for time series data with consistent value lengths.\n\nThis model validates a dictionary where:\n- Keys are strings representing data series names\n- Values are lists of numeric or string values\n- Special keys 'start_datetime' and 'interval' can contain string values\nfor time series indexing\n- All value lists must have the same length\n\nExample:\n {\n \"start_datetime\": \"2024-01-01 00:00:00\", # optional\n \"interval\": \"1 Hour\", # optional\n \"load_mean\": [20.5, 21.0, 22.1],\n \"load_min\": [18.5, 19.0, 20.1]\n }"
|
|
},
|
|
"PydanticDateTimeDataFrame": {
|
|
"properties": {
|
|
"data": {
|
|
"additionalProperties": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": "object",
|
|
"title": "Data"
|
|
},
|
|
"dtypes": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object",
|
|
"title": "Dtypes"
|
|
},
|
|
"tz": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Tz",
|
|
"description": "Timezone for datetime values"
|
|
},
|
|
"datetime_columns": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"title": "Datetime Columns",
|
|
"description": "Columns to be treated as datetime"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "PydanticDateTimeDataFrame",
|
|
"description": "Pydantic model for validating pandas DataFrame data with datetime index."
|
|
},
|
|
"PydanticDateTimeSeries": {
|
|
"properties": {
|
|
"data": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Data"
|
|
},
|
|
"dtype": {
|
|
"type": "string",
|
|
"title": "Dtype",
|
|
"default": "float64"
|
|
},
|
|
"tz": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Tz"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "PydanticDateTimeSeries",
|
|
"description": "Pydantic model for validating pandas Series with datetime index in JSON format.\n\nThis model handles Series data serialized with orient='index', where the keys are\ndatetime strings and values are the series values. Provides validation and\nconversion between JSON and pandas Series with datetime index.\n\nAttributes:\n data (Dict[str, Any]): Dictionary mapping datetime strings to values.\n dtype (str): The data type of the series values.\n tz (str | None): Timezone name if the datetime index is timezone-aware."
|
|
},
|
|
"ServerCommonSettings": {
|
|
"properties": {
|
|
"host": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Host",
|
|
"description": "EOS server IP address. Defaults to 127.0.0.1.",
|
|
"default": "127.0.0.1",
|
|
"examples": [
|
|
"127.0.0.1",
|
|
"localhost"
|
|
]
|
|
},
|
|
"port": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Port",
|
|
"description": "EOS server IP port number. Defaults to 8503.",
|
|
"default": 8503,
|
|
"examples": [
|
|
8503
|
|
]
|
|
},
|
|
"verbose": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Verbose",
|
|
"description": "Enable debug output",
|
|
"default": false
|
|
},
|
|
"startup_eosdash": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Startup Eosdash",
|
|
"description": "EOS server to start EOSdash server. Defaults to True.",
|
|
"default": true
|
|
},
|
|
"eosdash_host": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Eosdash Host",
|
|
"description": "EOSdash server IP address. Defaults to EOS server IP address.",
|
|
"examples": [
|
|
"127.0.0.1",
|
|
"localhost"
|
|
]
|
|
},
|
|
"eosdash_port": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Eosdash Port",
|
|
"description": "EOSdash server IP port number. Defaults to EOS server IP port number + 1.",
|
|
"examples": [
|
|
8504
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "ServerCommonSettings",
|
|
"description": "Server Configuration."
|
|
},
|
|
"SettingsEOS": {
|
|
"properties": {
|
|
"general": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/GeneralSettings-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "General Settings"
|
|
},
|
|
"cache": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CacheCommonSettings"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Cache Settings"
|
|
},
|
|
"ems": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/EnergyManagementCommonSettings"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Energy Management Settings"
|
|
},
|
|
"logging": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/LoggingCommonSettings-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Logging Settings"
|
|
},
|
|
"devices": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DevicesCommonSettings-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Devices Settings"
|
|
},
|
|
"measurement": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MeasurementCommonSettings-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Measurement Settings"
|
|
},
|
|
"optimization": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OptimizationCommonSettings"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optimization Settings"
|
|
},
|
|
"prediction": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PredictionCommonSettings"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Prediction Settings"
|
|
},
|
|
"elecprice": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ElecPriceCommonSettings-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Electricity Price Settings"
|
|
},
|
|
"feedintariff": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FeedInTariffCommonSettings-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Feed In Tariff Settings"
|
|
},
|
|
"load": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/LoadCommonSettings-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Load Settings"
|
|
},
|
|
"pvforecast": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PVForecastCommonSettings-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "PV Forecast Settings"
|
|
},
|
|
"weather": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/WeatherCommonSettings-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Weather Settings"
|
|
},
|
|
"server": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ServerCommonSettings"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Server Settings"
|
|
},
|
|
"utils": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UtilsCommonSettings"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Utilities Settings"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"type": "object",
|
|
"title": "SettingsEOS",
|
|
"description": "Settings for all EOS.\n\nOnly used to update the configuration with specific settings."
|
|
},
|
|
"SolarPanelBatteryParameters": {
|
|
"properties": {
|
|
"device_id": {
|
|
"type": "string",
|
|
"title": "Device Id",
|
|
"description": "ID of battery",
|
|
"examples": [
|
|
"battery1"
|
|
]
|
|
},
|
|
"hours": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Hours",
|
|
"description": "Number of prediction hours. Defaults to global config prediction hours.",
|
|
"examples": [
|
|
null
|
|
]
|
|
},
|
|
"capacity_wh": {
|
|
"type": "integer",
|
|
"exclusiveMinimum": 0.0,
|
|
"title": "Capacity Wh",
|
|
"description": "An integer representing the capacity of the battery in watt-hours.",
|
|
"examples": [
|
|
8000
|
|
]
|
|
},
|
|
"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,
|
|
"examples": [
|
|
42
|
|
]
|
|
},
|
|
"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,
|
|
"examples": [
|
|
10
|
|
]
|
|
},
|
|
"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
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"type": "object",
|
|
"required": [
|
|
"device_id",
|
|
"capacity_wh"
|
|
],
|
|
"title": "SolarPanelBatteryParameters",
|
|
"description": "PV battery device simulation configuration."
|
|
},
|
|
"TimeWindow-Input": {
|
|
"properties": {
|
|
"start_time": {
|
|
"title": "Start Time",
|
|
"description": "Start time of the time window (time of day)."
|
|
},
|
|
"duration": {
|
|
"type": "string",
|
|
"format": "duration",
|
|
"title": "Duration",
|
|
"description": "Duration of the time window starting from `start_time`."
|
|
},
|
|
"day_of_week": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Day Of Week",
|
|
"description": "Optional day of the week restriction. Can be specified as integer (0=Monday to 6=Sunday) or localized weekday name. If None, applies every day unless `date` is set."
|
|
},
|
|
"date": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Date",
|
|
"description": "Optional specific calendar date for the time window. Overrides `day_of_week` if set."
|
|
},
|
|
"locale": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Locale",
|
|
"description": "Locale used to parse weekday names in `day_of_week` when given as string. If not set, Pendulum's default locale is used. Examples: 'en', 'de', 'fr', etc."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"start_time",
|
|
"duration"
|
|
],
|
|
"title": "TimeWindow",
|
|
"description": "Model defining a daily or specific date time window with optional localization support.\n\nRepresents a time interval starting at `start_time` and lasting for `duration`.\nCan restrict applicability to a specific day of the week or a specific calendar date.\nSupports day names in multiple languages via locale-aware parsing."
|
|
},
|
|
"TimeWindow-Output": {
|
|
"properties": {
|
|
"start_time": {
|
|
"type": "string",
|
|
"title": "Start Time",
|
|
"description": "Start time of the time window (time of day)."
|
|
},
|
|
"duration": {
|
|
"type": "string",
|
|
"title": "Duration",
|
|
"description": "Duration of the time window starting from `start_time`."
|
|
},
|
|
"day_of_week": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Day Of Week",
|
|
"description": "Optional day of the week restriction. Can be specified as integer (0=Monday to 6=Sunday) or localized weekday name. If None, applies every day unless `date` is set."
|
|
},
|
|
"date": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Date",
|
|
"description": "Optional specific calendar date for the time window. Overrides `day_of_week` if set."
|
|
},
|
|
"locale": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Locale",
|
|
"description": "Locale used to parse weekday names in `day_of_week` when given as string. If not set, Pendulum's default locale is used. Examples: 'en', 'de', 'fr', etc."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"start_time",
|
|
"duration"
|
|
],
|
|
"title": "TimeWindow",
|
|
"description": "Model defining a daily or specific date time window with optional localization support.\n\nRepresents a time interval starting at `start_time` and lasting for `duration`.\nCan restrict applicability to a specific day of the week or a specific calendar date.\nSupports day names in multiple languages via locale-aware parsing."
|
|
},
|
|
"TimeWindowSequence-Input": {
|
|
"properties": {
|
|
"windows": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/TimeWindow-Input"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Windows",
|
|
"description": "List of TimeWindow objects that make up this sequence."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "TimeWindowSequence",
|
|
"description": "Model representing a sequence of time windows with collective operations.\n\nManages multiple TimeWindow objects and provides methods to work with them\nas a cohesive unit for scheduling and availability checking."
|
|
},
|
|
"TimeWindowSequence-Output": {
|
|
"properties": {
|
|
"windows": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/TimeWindow-Output"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Windows",
|
|
"description": "List of TimeWindow objects that make up this sequence."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "TimeWindowSequence",
|
|
"description": "Model representing a sequence of time windows with collective operations.\n\nManages multiple TimeWindow objects and provides methods to work with them\nas a cohesive unit for scheduling and availability checking."
|
|
},
|
|
"UtilsCommonSettings": {
|
|
"properties": {},
|
|
"type": "object",
|
|
"title": "UtilsCommonSettings",
|
|
"description": "Utils Configuration."
|
|
},
|
|
"ValidationError": {
|
|
"properties": {
|
|
"loc": {
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "integer"
|
|
}
|
|
]
|
|
},
|
|
"type": "array",
|
|
"title": "Location"
|
|
},
|
|
"msg": {
|
|
"type": "string",
|
|
"title": "Message"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"title": "Error Type"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"loc",
|
|
"msg",
|
|
"type"
|
|
],
|
|
"title": "ValidationError"
|
|
},
|
|
"WeatherCommonProviderSettings": {
|
|
"properties": {
|
|
"WeatherImport": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/WeatherImportCommonSettings"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "WeatherImport settings",
|
|
"examples": [
|
|
null
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "WeatherCommonProviderSettings",
|
|
"description": "Weather Forecast Provider Configuration."
|
|
},
|
|
"WeatherCommonSettings-Input": {
|
|
"properties": {
|
|
"provider": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Provider",
|
|
"description": "Weather provider id of provider to be used.",
|
|
"examples": [
|
|
"WeatherImport"
|
|
]
|
|
},
|
|
"provider_settings": {
|
|
"$ref": "#/components/schemas/WeatherCommonProviderSettings",
|
|
"description": "Provider settings",
|
|
"examples": [
|
|
{}
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "WeatherCommonSettings",
|
|
"description": "Weather Forecast Configuration."
|
|
},
|
|
"WeatherCommonSettings-Output": {
|
|
"properties": {
|
|
"provider": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Provider",
|
|
"description": "Weather provider id of provider to be used.",
|
|
"examples": [
|
|
"WeatherImport"
|
|
]
|
|
},
|
|
"provider_settings": {
|
|
"$ref": "#/components/schemas/WeatherCommonProviderSettings",
|
|
"description": "Provider settings",
|
|
"examples": [
|
|
{}
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "WeatherCommonSettings",
|
|
"description": "Weather Forecast Configuration."
|
|
},
|
|
"WeatherImportCommonSettings": {
|
|
"properties": {
|
|
"import_file_path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"format": "path"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Import File Path",
|
|
"description": "Path to the file to import weather data from.",
|
|
"examples": [
|
|
null,
|
|
"/path/to/weather_data.json"
|
|
]
|
|
},
|
|
"import_json": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Import Json",
|
|
"description": "JSON string, dictionary of weather forecast value lists.",
|
|
"examples": [
|
|
"{\"weather_temp_air\": [18.3, 17.8, 16.9]}"
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "WeatherImportCommonSettings",
|
|
"description": "Common settings for weather data import from file or JSON string."
|
|
}
|
|
}
|
|
}
|
|
} |