"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.\n\n## Currency Information\n\nAll monetary values in this API are expressed in the locally configured currency of the EOS installation. The system is designed to work with any currency (e.g., EUR, SEK, CHF, USD, GBP, etc.). Each installation uses a single, consistent currency throughout all endpoints and responses.\n\nValues are given in whole currency units, not in hundredth subunits: a value of `0.0003` in an installation configured for Euro means 0.0003 EUR/Wh (i.e. 0.30 EUR/kWh), never cents. The same applies to all totals (e.g. `total_costs` of `1.5` = 1.50 EUR).\n\nField names containing cost, price, revenue, tariff, or similar monetary terms (e.g., `total_costs`, `electricity_price_per_wh`, `revenue_per_hour`) represent amounts in the configured currency, without explicit currency designation in the field name to maintain currency-neutrality.\n\n## Deprecated Field Names\n\nThe genetic optimization API fields were renamed from German to English. For backward compatibility the old German field names (e.g. `gesamtlast`, `pv_prognose_wh`, `Gesamtbilanz_Euro`) are still accepted on input and are emitted in responses alongside the English names, marked as deprecated in the schema. They will be removed in a future release \u2014 new clients should use the English field names only.\n",
"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.",
"description":"Get the EOS configuration backup identifiers and backup metadata.\n\nReturns:\n dict[str, dict[str, Any]]: Mapping of backup identifiers to metadata.",
"title":"Response Fastapi Config Backup Get V1 Config Backup Get"
}
}
}
}
}
}
},
"/v1/config/revert":{
"put":{
"tags":[
"config"
],
"summary":"Fastapi Config Revert Put",
"description":"Revert the configuration to a EOS configuration backup.\n\nReturns:\n configuration (ConfigEOS): The current configuration after revert.",
"description":"Save the current configuration to the EOS configuration file.\n\nReturns:\n configuration (ConfigEOS): The current configuration that was saved.",
"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.",
"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.",
"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.",
"description":"Get a list of available prediction providers.\n\nArgs:\n enabled (bool): Return enabled/disabled providers. If unset, return all providers.",
"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.",
"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.",
"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.",
"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.",
"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.",
"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.",
"description":"Deprecated: Electricity Market Price Prediction per Wh [amount/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.",
"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=loadforecast_power_w' 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'",
"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=loadforecast_power_w' instead.",
"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.",
"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\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 .. code-block:: python\n\n config_eos = ConfigEOS() # Always returns the same instance\n print(config_eos.prediction.hours) # Access a setting from the loaded configuration"
"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."
"description":"Database provider id of provider to be used.",
"examples":[
"LMDB"
]
},
"compression_level":{
"type":"integer",
"maximum":9.0,
"minimum":0.0,
"title":"Compression Level",
"description":"Compression level for database record data.",
"default":9,
"examples":[
0,
9
]
},
"initial_load_window_h":{
"anyOf":[
{
"type":"integer",
"minimum":0.0
},
{
"type":"null"
}
],
"title":"Initial Load Window H",
"description":"Specifies the default duration of the initial load window when loading records from the database, in hours. If set to None, the full available range is loaded. The window is centered around the current time by default, unless a different center time is specified. Different database namespaces may define their own default windows.",
"examples":[
"48",
"None"
]
},
"keep_duration_h":{
"anyOf":[
{
"type":"integer",
"minimum":0.0
},
{
"type":"null"
}
],
"title":"Keep Duration H",
"description":"Default maximum duration records shall be kept in database [hours, none].\nNone indicates forever. Database namespaces may have diverging definitions.",
"examples":[
48,
"none"
]
},
"autosave_interval_sec":{
"anyOf":[
{
"type":"integer",
"minimum":5.0
},
{
"type":"null"
}
],
"title":"Autosave Interval Sec",
"description":"Automatic saving interval [seconds].\nSet to None to disable automatic saving.",
"default":10,
"examples":[
5
]
},
"compaction_interval_sec":{
"anyOf":[
{
"type":"integer",
"minimum":0.0
},
{
"type":"null"
}
],
"title":"Compaction Interval Sec",
"description":"Interval in between automatic tiered compaction runs [seconds].\nCompaction downsamples old records to reduce storage while retaining coverage. Set to None to disable automatic compaction.",
"description":"Number of records to process in batch operations.",
"default":100,
"examples":[
100
]
}
},
"type":"object",
"title":"DatabaseCommonSettings",
"description":"Configuration model for database settings.\n\nAttributes:\n provider: Optional provider identifier (e.g. \"LMDB\").\n max_records_in_memory: Maximum records kept in memory before auto-save.\n auto_save: Whether to auto-save when threshold exceeded.\n batch_size: Batch size for batch operations."
},
"DatabaseCommonSettings-Output":{
"properties":{
"provider":{
"anyOf":[
{
"type":"string"
},
{
"type":"null"
}
],
"title":"Provider",
"description":"Database provider id of provider to be used.",
"examples":[
"LMDB"
]
},
"compression_level":{
"type":"integer",
"maximum":9.0,
"minimum":0.0,
"title":"Compression Level",
"description":"Compression level for database record data.",
"default":9,
"examples":[
0,
9
]
},
"initial_load_window_h":{
"anyOf":[
{
"type":"integer",
"minimum":0.0
},
{
"type":"null"
}
],
"title":"Initial Load Window H",
"description":"Specifies the default duration of the initial load window when loading records from the database, in hours. If set to None, the full available range is loaded. The window is centered around the current time by default, unless a different center time is specified. Different database namespaces may define their own default windows.",
"examples":[
"48",
"None"
]
},
"keep_duration_h":{
"anyOf":[
{
"type":"integer",
"minimum":0.0
},
{
"type":"null"
}
],
"title":"Keep Duration H",
"description":"Default maximum duration records shall be kept in database [hours, none].\nNone indicates forever. Database namespaces may have diverging definitions.",
"examples":[
48,
"none"
]
},
"autosave_interval_sec":{
"anyOf":[
{
"type":"integer",
"minimum":5.0
},
{
"type":"null"
}
],
"title":"Autosave Interval Sec",
"description":"Automatic saving interval [seconds].\nSet to None to disable automatic saving.",
"default":10,
"examples":[
5
]
},
"compaction_interval_sec":{
"anyOf":[
{
"type":"integer",
"minimum":0.0
},
{
"type":"null"
}
],
"title":"Compaction Interval Sec",
"description":"Interval in between automatic tiered compaction runs [seconds].\nCompaction downsamples old records to reduce storage while retaining coverage. Set to None to disable automatic compaction.",
"description":"Number of records to process in batch operations.",
"default":100,
"examples":[
100
]
},
"providers":{
"items":{
"type":"string"
},
"type":"array",
"title":"Providers",
"description":"Return available database provider ids.",
"readOnly":true
}
},
"type":"object",
"required":[
"providers"
],
"title":"DatabaseCommonSettings",
"description":"Configuration model for database settings.\n\nAttributes:\n provider: Optional provider identifier (e.g. \"LMDB\").\n max_records_in_memory: Maximum records kept in memory before auto-save.\n auto_save: Whether to auto-save when threshold exceeded.\n batch_size: Batch size for batch operations."
"description":"Sequence of time windows defining the fixed price schedule. If not provided, no fixed pricing is applied.",
"examples":[
{
"windows":[
{
"duration":"8 hours",
"start_time":"00:00",
"value":0.288
},
{
"duration":"16 hours",
"start_time":"08:00",
"value":0.34
}
]
}
]
}
},
"type":"object",
"title":"ElecPriceFixedCommonSettings",
"description":"Common configuration settings for fixed electricity pricing.\n\nThis model defines a fixed electricity price schedule using a sequence\nof time windows. Each window specifies a time interval and the electricity\nprice applicable during that interval."
"description":"Sequence of time windows defining the fixed price schedule. If not provided, no fixed pricing is applied.",
"examples":[
{
"windows":[
{
"duration":"8 hours",
"start_time":"00:00",
"value":0.288
},
{
"duration":"16 hours",
"start_time":"08:00",
"value":0.34
}
]
}
]
}
},
"type":"object",
"title":"ElecPriceFixedCommonSettings",
"description":"Common configuration settings for fixed electricity pricing.\n\nThis model defines a fixed electricity price schedule using a sequence\nof time windows. Each window specifies a time interval and the electricity\nprice applicable during that interval."
"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."
"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."
"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."
},
"FeedInTariffCommonSettings-Input":{
"properties":{
"provider":{
"anyOf":[
{
"type":"string"
},
{
"type":"null"
}
],
"title":"Provider",
"description":"Feed in tariff provider id of provider to be used.",
"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"
]
},
"ac_to_dc_efficiency":{
"type":"number",
"maximum":1.0,
"minimum":0.0,
"title":"Ac To Dc Efficiency",
"description":"Efficiency of AC to DC conversion (for AC/grid charging of battery). Set to 0 to disable AC charging via inverter. Default 1.0 for backward compatibility (no additional inverter loss).",
"default":1.0,
"examples":[
0.95,
1.0,
0.0
]
},
"dc_to_ac_efficiency":{
"type":"number",
"maximum":1.0,
"exclusiveMinimum":0.0,
"title":"Dc To Ac Efficiency",
"description":"Efficiency of DC to AC conversion (for battery discharging to AC load/grid). Default 1.0 for backward compatibility (no additional inverter loss).",
"default":1.0,
"examples":[
0.95,
1.0
]
},
"max_ac_charge_power_w":{
"anyOf":[
{
"type":"number",
"minimum":0.0
},
{
"type":"null"
}
],
"title":"Max Ac Charge Power W",
"description":"Maximum AC charging power in watts. None means no additional limit (battery's own max_charge_power_w applies). Set to 0 to disable AC charging.",
"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)."
}
},
"type":"object",
"required":[
"ems",
"pv_battery",
"inverter",
"ev"
],
"title":"Genetic0OptimizationParameters",
"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."
},
"Genetic0SimulationResult":{
"properties":{
"load_wh_per_hour":{
"items":{
"type":"number"
},
"type":"array",
"title":"Load Wh Per Hour",
"description":"The load in watt-hours per hour."
},
"ev_soc_per_hour":{
"items":{
"type":"number"
},
"type":"array",
"title":"Ev Soc Per Hour",
"description":"The state of charge of the EV for each hour."
},
"revenue_per_hour":{
"items":{
"type":"number"
},
"type":"array",
"title":"Revenue Per Hour",
"description":"The revenue from grid feed-in or other sources per hour."
},
"total_losses":{
"type":"number",
"title":"Total Losses",
"description":"The total losses in watt-hours over the entire period."
},
"total_balance":{
"type":"number",
"title":"Total Balance",
"description":"The total balance of revenues minus costs."
},
"total_revenue":{
"type":"number",
"title":"Total Revenue",
"description":"The total revenues."
},
"total_costs":{
"type":"number",
"title":"Total Costs",
"description":"The total costs."
},
"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."
},
"costs_per_hour":{
"items":{
"type":"number"
},
"type":"array",
"title":"Costs Per Hour",
"description":"The costs per hour."
},
"grid_consumption_wh_per_hour":{
"items":{
"type":"number"
},
"type":"array",
"title":"Grid Consumption Wh Per Hour",
"description":"The grid energy drawn in watt-hours per hour."
},
"grid_feed_in_wh_per_hour":{
"items":{
"type":"number"
},
"type":"array",
"title":"Grid Feed In Wh Per Hour",
"description":"The energy fed into the grid in watt-hours per hour."
},
"losses_per_hour":{
"items":{
"type":"number"
},
"type":"array",
"title":"Losses Per Hour",
"description":"The losses in watt-hours per hour."
},
"battery_soc_per_hour":{
"items":{
"type":"number"
},
"type":"array",
"title":"Battery Soc Per Hour",
"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"
},
"Last_Wh_pro_Stunde":{
"items":{
"type":"number"
},
"type":"array",
"title":"Last Wh Pro Stunde",
"description":"Deprecated: Use load_wh_per_hour instead.",
"deprecated":true,
"readOnly":true
},
"EAuto_SoC_pro_Stunde":{
"items":{
"type":"number"
},
"type":"array",
"title":"Eauto Soc Pro Stunde",
"description":"Deprecated: Use ev_soc_per_hour instead.",
"deprecated":true,
"readOnly":true
},
"Einnahmen_Euro_pro_Stunde":{
"items":{
"type":"number"
},
"type":"array",
"title":"Einnahmen Euro Pro Stunde",
"description":"Deprecated: Use revenue_per_hour instead.",
"deprecated":true,
"readOnly":true
},
"Gesamt_Verluste":{
"type":"number",
"title":"Gesamt Verluste",
"description":"Deprecated: Use total_losses instead.",
"deprecated":true,
"readOnly":true
},
"Gesamtbilanz_Euro":{
"type":"number",
"title":"Gesamtbilanz Euro",
"description":"Deprecated: Use total_balance instead.",
"deprecated":true,
"readOnly":true
},
"Gesamteinnahmen_Euro":{
"type":"number",
"title":"Gesamteinnahmen Euro",
"description":"Deprecated: Use total_revenue instead.",
"deprecated":true,
"readOnly":true
},
"Gesamtkosten_Euro":{
"type":"number",
"title":"Gesamtkosten Euro",
"description":"Deprecated: Use total_costs instead.",
"deprecated":true,
"readOnly":true
},
"Home_appliance_wh_per_hour":{
"items":{
"anyOf":[
{
"type":"number"
},
{
"type":"null"
}
]
},
"type":"array",
"title":"Home Appliance Wh Per Hour",
"description":"Deprecated: Use home_appliance_wh_per_hour instead.",
"deprecated":true,
"readOnly":true
},
"Kosten_Euro_pro_Stunde":{
"items":{
"type":"number"
},
"type":"array",
"title":"Kosten Euro Pro Stunde",
"description":"Deprecated: Use costs_per_hour instead.",
"deprecated":true,
"readOnly":true
},
"Netzbezug_Wh_pro_Stunde":{
"items":{
"type":"number"
},
"type":"array",
"title":"Netzbezug Wh Pro Stunde",
"description":"Deprecated: Use grid_consumption_wh_per_hour instead.",
"deprecated":true,
"readOnly":true
},
"Netzeinspeisung_Wh_pro_Stunde":{
"items":{
"type":"number"
},
"type":"array",
"title":"Netzeinspeisung Wh Pro Stunde",
"description":"Deprecated: Use grid_feed_in_wh_per_hour instead.",
"deprecated":true,
"readOnly":true
},
"Verluste_Pro_Stunde":{
"items":{
"type":"number"
},
"type":"array",
"title":"Verluste Pro Stunde",
"description":"Deprecated: Use losses_per_hour instead.",
"deprecated":true,
"readOnly":true
},
"akku_soc_pro_stunde":{
"items":{
"type":"number"
},
"type":"array",
"title":"Akku Soc Pro Stunde",
"description":"Deprecated: Use battery_soc_per_hour instead.",
"deprecated":true,
"readOnly":true
},
"Electricity_price":{
"items":{
"type":"number"
},
"type":"array",
"title":"Electricity Price",
"description":"Deprecated: Use electricity_price instead.",
"deprecated":true,
"readOnly":true
}
},
"type":"object",
"required":[
"load_wh_per_hour",
"ev_soc_per_hour",
"revenue_per_hour",
"total_losses",
"total_balance",
"total_revenue",
"total_costs",
"home_appliance_wh_per_hour",
"costs_per_hour",
"grid_consumption_wh_per_hour",
"grid_feed_in_wh_per_hour",
"losses_per_hour",
"battery_soc_per_hour",
"electricity_price",
"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":"Genetic0SimulationResult",
"description":"This object contains the results of the simulation and provides insights into various parameters over the entire forecast period."
},
"Genetic0SolarPanelBatteryParameters":{
"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
},
"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.",
"description":"**Note**: The first value of \"load_wh_per_hour\", \"grid_feed_in_wh_per_hour\", and \"grid_consumption_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."
},
"GeneticCommonSettings-Input":{
"properties":{
"interval_sec":{
"type":"integer",
"maximum":3600.0,
"minimum":900.0,
"title":"Interval Sec",
"description":"The optimization interval [sec]. Defaults to 3600 seconds (1 hour)",
"default":3600,
"examples":[
3600,
900
]
},
"horizon_hours":{
"type":"integer",
"minimum":0.0,
"title":"Horizon Hours",
"description":"The general time window within which the energy optimization goal shall be achieved [h]. Defaults to 24 hours.",
"description":"**Note**: The first value of \"load_wh_per_hour\", \"grid_feed_in_wh_per_hour\", and \"grid_consumption_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."
"description":"Mapping of EOS config keys to Home Assistant entity IDs.\nThe config key has to be given by a \u2018/\u2019-separated path\ne.g. devices/batteries/0/capacity_wh",
"description":"Entity IDs for device (resource) instructions to be updated by EOS.\nThe device ids (resource ids) have to be prepended by 'sensor.eos_' to build the entity_id.\nE.g. The instruction for device id 'battery1' becomes the entity_id 'sensor.eos_battery1'.",
"examples":[
[
"sensor.eos_battery1"
]
]
},
"solution_entity_ids":{
"anyOf":[
{
"items":{
"type":"string"
},
"type":"array"
},
{
"type":"null"
}
],
"title":"Solution Entity Ids",
"description":"Entity IDs for optimization solution keys to be updated by EOS.\nThe solution keys have to be prepended by 'sensor.eos_' to build the entity_id.\nE.g. solution key 'battery1_idle_op_mode' becomes the entity_id 'sensor.eos_battery1_idle_op_mode'.",
"examples":[
[
"sensor.eos_battery1_idle_mode_mode"
]
]
}
},
"type":"object",
"title":"HomeAssistantAdapterCommonSettings",
"description":"Common settings for the home assistant adapter."
},
"HomeAssistantAdapterCommonSettings-Output":{
"properties":{
"config_entity_ids":{
"anyOf":[
{
"additionalProperties":{
"type":"string"
},
"type":"object"
},
{
"type":"null"
}
],
"title":"Config Entity Ids",
"description":"Mapping of EOS config keys to Home Assistant entity IDs.\nThe config key has to be given by a \u2018/\u2019-separated path\ne.g. devices/batteries/0/capacity_wh",
"description":"Entity IDs for device (resource) instructions to be updated by EOS.\nThe device ids (resource ids) have to be prepended by 'sensor.eos_' to build the entity_id.\nE.g. The instruction for device id 'battery1' becomes the entity_id 'sensor.eos_battery1'.",
"examples":[
[
"sensor.eos_battery1"
]
]
},
"solution_entity_ids":{
"anyOf":[
{
"items":{
"type":"string"
},
"type":"array"
},
{
"type":"null"
}
],
"title":"Solution Entity Ids",
"description":"Entity IDs for optimization solution keys to be updated by EOS.\nThe solution keys have to be prepended by 'sensor.eos_' to build the entity_id.\nE.g. solution key 'battery1_idle_op_mode' becomes the entity_id 'sensor.eos_battery1_idle_op_mode'.",
"examples":[
[
"sensor.eos_battery1_idle_mode_mode"
]
]
},
"homeassistant_entity_ids":{
"items":{
"type":"string"
},
"type":"array",
"title":"Homeassistant Entity Ids",
"description":"Entity IDs available at Home Assistant.",
"readOnly":true
},
"eos_solution_entity_ids":{
"items":{
"type":"string"
},
"type":"array",
"title":"Eos Solution Entity Ids",
"description":"Entity IDs for optimization solution available at EOS.",
"readOnly":true
},
"eos_device_instruction_entity_ids":{
"items":{
"type":"string"
},
"type":"array",
"title":"Eos Device Instruction Entity Ids",
"description":"Entity IDs for energy management instructions available at EOS.",
"readOnly":true
}
},
"type":"object",
"required":[
"homeassistant_entity_ids",
"eos_solution_entity_ids",
"eos_device_instruction_entity_ids"
],
"title":"HomeAssistantAdapterCommonSettings",
"description":"Common settings for the home assistant adapter."
"description":"Efficiency of AC to DC conversion for grid-to-battery AC charging (0-1). Set to 0 to disable AC charging. Default 1.0 (no additional inverter loss).",
"default":1.0,
"examples":[
0.95,
1.0,
0.0
]
},
"dc_to_ac_efficiency":{
"type":"number",
"maximum":1.0,
"exclusiveMinimum":0.0,
"title":"Dc To Ac Efficiency",
"description":"Efficiency of DC to AC conversion for battery discharging to AC load/grid (0-1). Default 1.0 (no additional inverter loss).",
"default":1.0,
"examples":[
0.95,
1.0
]
},
"max_ac_charge_power_w":{
"anyOf":[
{
"type":"number",
"minimum":0.0
},
{
"type":"null"
}
],
"title":"Max Ac Charge Power W",
"description":"Maximum AC charging power in watts. null means no additional limit. Set to 0 to disable AC charging.",
"description":"Efficiency of AC to DC conversion for grid-to-battery AC charging (0-1). Set to 0 to disable AC charging. Default 1.0 (no additional inverter loss).",
"default":1.0,
"examples":[
0.95,
1.0,
0.0
]
},
"dc_to_ac_efficiency":{
"type":"number",
"maximum":1.0,
"exclusiveMinimum":0.0,
"title":"Dc To Ac Efficiency",
"description":"Efficiency of DC to AC conversion for battery discharging to AC load/grid (0-1). Default 1.0 (no additional inverter loss).",
"default":1.0,
"examples":[
0.95,
1.0
]
},
"max_ac_charge_power_w":{
"anyOf":[
{
"type":"number",
"minimum":0.0
},
{
"type":"null"
}
],
"title":"Max Ac Charge Power W",
"description":"Maximum AC charging power in watts. null means no additional limit. Set to 0 to disable AC charging.",
"description":"Node-RED 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":"Node-RED server IP port number. Defaults to 1880.",
"default":1880,
"examples":[
1880
]
}
},
"type":"object",
"title":"NodeREDAdapterCommonSettings",
"description":"Common settings for the NodeRED adapter.\n\nThe Node-RED adapter sends to HTTP IN nodes.\n\nThis is the example flow:\n\n[HTTP In \\\\<URL\\\\>] -> [Function (parse payload)] -> [Debug] -> [HTTP Response]\n\nThere are two URLs that are used:\n\n- GET /eos/data_aquisition\n The GET is issued before the optimization.\n- POST /eos/control_dispatch\n The POST is issued after the optimization."
"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."
"description":"Datetime data frame with time series prediction data per optimization interval:- pv_energy_wh: PV energy prediction (positive) in wh- elec_price_amt_kwh: Electricity price prediction in money per kwh- feed_in_tariff_amt_kwh: Feed in tariff prediction in money per kwh- weather_temp_air_celcius: Temperature in \u00b0C- loadforecast_energy_wh: Load mean energy prediction in wh- loadakkudoktor_std_energy_wh: Load energy standard deviation prediction in wh- loadakkudoktor_mean_energy_wh: Load mean energy prediction in wh"
"description":"Datetime data frame with time series solution 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- 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."
"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."
"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."
"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."
"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."
"description":"pvnode.com API key (Bearer auth). Required.",
"default":"",
"examples":[
"pvn_live_xxxxxxxxxxxxxxxx"
]
},
"site_id":{
"anyOf":[
{
"type":"string"
},
{
"type":"null"
}
],
"title":"Site Id",
"description":"pvnode.com site id of the saved plant ('Anlagen-ID'). When set, the saved (possibly calibrated) site is used. Leave empty to send the configured pvforecast.planes inline instead.",
"examples":[
"abcd-1234"
]
},
"forecast_days":{
"type":"integer",
"maximum":7.0,
"minimum":1.0,
"title":"Forecast Days",
"description":"Forecast horizon in days (1-7, capped by the pvnode plan).",
"default":2,
"examples":[
2
]
}
},
"type":"object",
"title":"PVForecastPVNodeCommonSettings",
"description":"Common settings for the pvnode.com PV forecast provider."
"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."
"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 .. code-block:: python\n\n {\n \"start_datetime\": \"2024-01-01 00:00:00\", # optional\n \"interval\": \"1 hour\", # optional\n \"loadforecast_power_w\": [20.5, 21.0, 22.1],\n \"load_min\": [18.5, 19.0, 20.1]\n }"
"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."
"description":"The name of the target user to switch to. If ``None`` (default), the current effective user is used and no privilege change is attempted.",
"examples":[
null,
"user"
]
},
"reload":{
"anyOf":[
{
"type":"boolean"
},
{
"type":"null"
}
],
"title":"Reload",
"description":"Enable server auto-reload for debugging or development. Default is False. Monitors the package directory for changes and reloads the server.",
"description":"Naive start time of the time window (time of day, no timezone). Interpreted in the timezone of the datetime passed to contains() or earliest_start_time().",
"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.",
"description":"Optional specific calendar date for the time window. Naive \u2014 matched against the local date of the datetime passed to contains(). Overrides `day_of_week` if set.",
"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.",
"description":"Model defining a daily or 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.\n\nTimezone contract:\n\n``start_time`` is always **naive** (no ``tzinfo``). It is interpreted as a\nlocal wall-clock time in whatever timezone the caller's ``date_time`` or\n``reference_date`` carries. When those arguments are timezone-aware the\nwindow boundaries are evaluated in that timezone; when they are naive,\narithmetic is performed as-is (no timezone conversion occurs).\n\n``date``, being a calendar ``Date`` object, is inherently timezone-free.\n\nThis design avoids the ambiguity that arises when a stored ``start_time``\ncarries its own timezone that differs from the caller's timezone, and keeps\nthe model serialisable without timezone state."
"description":"Naive start time of the time window (time of day, no timezone). Interpreted in the timezone of the datetime passed to contains() or earliest_start_time().",
"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.",
"description":"Optional specific calendar date for the time window. Naive \u2014 matched against the local date of the datetime passed to contains(). Overrides `day_of_week` if set.",
"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.",
"description":"Model defining a daily or 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.\n\nTimezone contract:\n\n``start_time`` is always **naive** (no ``tzinfo``). It is interpreted as a\nlocal wall-clock time in whatever timezone the caller's ``date_time`` or\n``reference_date`` carries. When those arguments are timezone-aware the\nwindow boundaries are evaluated in that timezone; when they are naive,\narithmetic is performed as-is (no timezone conversion occurs).\n\n``date``, being a calendar ``Date`` object, is inherently timezone-free.\n\nThis design avoids the ambiguity that arises when a stored ``start_time``\ncarries its own timezone that differs from the caller's timezone, and keeps\nthe model serialisable without timezone state."
"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."
"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."
"description":"Naive start time of the time window (time of day, no timezone). Interpreted in the timezone of the datetime passed to contains() or earliest_start_time().",
"examples":[
"00:00:00"
]
},
"duration":{
"type":"string",
"format":"duration",
"title":"Duration",
"description":"Duration of the time window starting from `start_time`.",
"examples":[
"2 hours"
]
},
"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.",
"examples":[
null
]
},
"date":{
"anyOf":[
{
"type":"string",
"format":"date"
},
{
"type":"null"
}
],
"title":"Date",
"description":"Optional specific calendar date for the time window. Naive \u2014 matched against the local date of the datetime passed to contains(). Overrides `day_of_week` if set.",
"examples":[
null
]
},
"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.",
"examples":[
null
]
},
"value":{
"anyOf":[
{
"type":"number",
"minimum":0.0
},
{
"type":"null"
}
],
"title":"Value",
"description":"Value applicable during this time window.",
"examples":[
0.288
]
}
},
"type":"object",
"required":[
"start_time",
"duration"
],
"title":"ValueTimeWindow",
"description":"Value applicable during a specific time window.\n\nThis model extends `TimeWindow` by associating a value with the defined time interval."
},
"ValueTimeWindow-Output":{
"properties":{
"start_time":{
"type":"string",
"title":"Start Time",
"description":"Naive start time of the time window (time of day, no timezone). Interpreted in the timezone of the datetime passed to contains() or earliest_start_time().",
"examples":[
"00:00:00"
]
},
"duration":{
"type":"string",
"title":"Duration",
"description":"Duration of the time window starting from `start_time`.",
"examples":[
"2 hours"
]
},
"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.",
"examples":[
null
]
},
"date":{
"anyOf":[
{
"type":"string",
"format":"date"
},
{
"type":"null"
}
],
"title":"Date",
"description":"Optional specific calendar date for the time window. Naive \u2014 matched against the local date of the datetime passed to contains(). Overrides `day_of_week` if set.",
"examples":[
null
]
},
"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.",
"examples":[
null
]
},
"value":{
"anyOf":[
{
"type":"number",
"minimum":0.0
},
{
"type":"null"
}
],
"title":"Value",
"description":"Value applicable during this time window.",
"examples":[
0.288
]
}
},
"type":"object",
"required":[
"start_time",
"duration"
],
"title":"ValueTimeWindow",
"description":"Value applicable during a specific time window.\n\nThis model extends `TimeWindow` by associating a value with the defined time interval."
"description":"Ordered list of value time windows. Each window defines a time interval and an associated value."
}
},
"type":"object",
"title":"ValueTimeWindowSequence",
"description":"Sequence of value time windows.\n\nThis model specializes `TimeWindowSequence` to ensure that all\ncontained windows are instances of `ValueTimeWindow`.\nIt provides the full set of sequence operations (containment checks,\navailability, start time calculations) for value windows."
"description":"Ordered list of value time windows. Each window defines a time interval and an associated value."
}
},
"type":"object",
"title":"ValueTimeWindowSequence",
"description":"Sequence of value time windows.\n\nThis model specializes `TimeWindowSequence` to ensure that all\ncontained windows are instances of `ValueTimeWindow`.\nIt provides the full set of sequence operations (containment checks,\navailability, start time calculations) for value windows."
