Feat/efficiencyfield support sensor

documentation/changelog.rst

@@ -13,7 +13,8 @@ New features
 -------------
 * Added API and UI support for copying assets and their subtrees [see `PR #2017 <https://www.github.com/FlexMeasures/flexmeasures/pull/2017>`_ and `PR #2120 <https://www.github.com/FlexMeasures/flexmeasures/pull/2120>`_]
 * Improve UX after deleting a child asset through the UI [see `PR #2119 <https://www.github.com/FlexMeasures/flexmeasures/pull/2119>`_]
-* Improve source filtering in the sensor data GET endpoint by exposing the documented query parameters in Swagger and allowing filtering by the account linked to data sources [see `PR #2083 <https://www.github.com/FlexMeasures/flexmeasures/pull/2083>`_ and `PR #2151 <https://www.github.com/FlexMeasures/flexmeasures/pull/2151>`_]
+* Improve source filtering in the sensor data GET endpoint by exposing the documented query parameters in Swagger and allowing filtering by the account linked to data sources [see `PR #2083 <https://www.github.com/FlexMeasures/flexmeasures/pull/2083>`_]
+* Support sensor references for efficiency fields in storage flex-models [see `PR #2142 <https://www.github.com/FlexMeasures/flexmeasures/pull/2142>`_]
 * Added a unified job status endpoint ``GET /api/v3_0/jobs/<uuid>`` to retrieve the current execution status and result message for any background job [see `PR #2141 <https://www.github.com/FlexMeasures/flexmeasures/pull/2141>`_]
 * New ``GET /api/v3_0/sources`` endpoint to list accessible data sources and defined types, with ``only_latest=true`` by default to return only the most recent version per source [see `PR #2126 <https://www.github.com/FlexMeasures/flexmeasures/pull/2126>`_]
 * Add support for filtering sensor data GET requests by ``source-type`` on ``/api/v3_0/sensors/<id>/data`` [see `PR #2127 <https://www.github.com/FlexMeasures/flexmeasures/pull/2127>`_]

flexmeasures/data/models/forecasting/__init__.py

@@ -6,9 +6,6 @@
 from typing import Any
 
 from flexmeasures.data.models.data_sources import DataGenerator
-from flexmeasures.data.models.forecasting.custom_models.base_model import (  # noqa: F401
-    BaseModel,
-)
 from flexmeasures.data.schemas.forecasting import ForecasterConfigSchema
 
 
@@ -103,3 +100,6 @@ def _clean_parameters(self, parameters: dict) -> dict:
         for field in fields_to_remove:
             _parameters.pop(field, None)
         return _parameters
+
+
+# End of module.

flexmeasures/data/schemas/scheduling/__init__.py

@@ -667,26 +667,26 @@ def _to_currency_per_mwh(price_unit: str) -> str:
         "default": None,
         "description": rst_to_openapi(metadata.CHARGING_EFFICIENCY.description),
         "types": {
-            "backend": "typeFive",
-            "ui": "Fixed value only.",
+            "backend": "typeThree",
+            "ui": "One fixed value or a dynamic signal (via a sensor).",
         },
         "example-units": EXAMPLE_UNIT_TYPES["efficiency"],
     },
     "discharging-efficiency": {
         "default": None,
         "description": rst_to_openapi(metadata.DISCHARGING_EFFICIENCY.description),
         "types": {
-            "backend": "typeFive",
-            "ui": "Fixed value only.",
+            "backend": "typeThree",
+            "ui": "One fixed value or a dynamic signal (via a sensor).",
         },
         "example-units": EXAMPLE_UNIT_TYPES["efficiency"],
     },
     "storage-efficiency": {
         "default": None,
         "description": rst_to_openapi(metadata.STORAGE_EFFICIENCY.description),
         "types": {
-            "backend": "typeFive",
-            "ui": "Fixed value only.",
+            "backend": "typeThree",
+            "ui": "One fixed value or a dynamic signal (via a sensor).",
         },
         "example-units": EXAMPLE_UNIT_TYPES["efficiency"],
     },

flexmeasures/data/schemas/scheduling/storage.py

@@ -40,7 +40,8 @@
 
 
 class EfficiencyField(QuantityField):
-    """Field that deserializes to a Quantity with % units. Must be greater than 0% and less than or equal to 100%.
+    """Field that deserializes to a Quantity with % units.
+    Fixed values must be greater than 0% and less than or equal to 100%.
 
     Examples:
 
@@ -455,7 +456,8 @@ class DBStorageFlexModelSchema(Schema):
         metadata={"deprecated field": "discharging-efficiency"},
     )
 
-    storage_efficiency = EfficiencyField(
+    storage_efficiency = VariableQuantityField(
+        "%",
         data_key="storage-efficiency",
         required=False,
         metadata={"deprecated field": "storage_efficiency"},

flexmeasures/data/schemas/tests/test_scheduling.py

@@ -782,15 +782,48 @@ def test_get_variable_quantity_unit(
             {"soc-usage": ["3500 kW", {"sensor": "power-sensor"}]},
             False,
         ),
+        (
+            {"roundtrip-efficiency": "90%"},
+            False,
+        ),
+        (
+            {"roundtrip-efficiency": "12 MW"},
+            {"roundtrip-efficiency": "Cannot convert value `12 MW` to '%'"},
+        ),
+        (
+            {"storage-efficiency": {"sensor": "efficiency-sensor"}},
+            False,
+        ),
+        (
+            {"storage-efficiency": {"sensor": "power-sensor"}},
+            {"storage-efficiency": "Cannot convert MW to %"},
+        ),
     ],
 )
-def test_db_flex_model_schema(db, app, setup_dummy_sensors, flex_model, fails):
+def test_db_flex_model_schema(
+    db, app, setup_dummy_sensors, setup_efficiency_sensors, flex_model, fails
+):
+    """Validate DBStorageFlexModelSchema for accepted and rejected flex-model inputs.
+
+    Input under test:
+    - ``flex_model`` payloads with fixed quantities, sensor references, and list fields
+        (for example ``soc-min``, ``soc-minima``, ``soc-gain``,
+        ``roundtrip-efficiency``, ``storage-efficiency``).
+    - Sensor placeholders in parametrized payloads are replaced with fixture-backed
+        sensor IDs before schema loading.
+
+    Expected outcomes:
+    - When ``fails`` is ``False``, schema loading succeeds.
+    - When ``fails`` is a field-to-message mapping, schema loading raises
+        ``ValidationError`` and contains the expected field-specific error message(s).
+    """
     schema = DBStorageFlexModelSchema()
 
     sensors = {
         "energy-sensor": setup_dummy_sensors[0],
         "price-sensor": setup_dummy_sensors[1],
         "power-sensor": setup_dummy_sensors[3],
+        "efficiency-sensor": setup_efficiency_sensors,
     }
 
     for field_name, field_value in flex_model.items():

flexmeasures/ui/templates/assets/asset_properties.html

@@ -454,6 +454,10 @@ <h5 class="modal-title pe-2">Edit {{ asset.name }}'s flex-model</h5>
                 validTypes = [Array];
             } else if (type === "typeFive") {
                 validTypes = [String];
+            } else {
+                // Raise error for unsupported type
+                showToast(`Unsupported type for field "${key}" in flex model schema.`, "error");
+                console.error(`Unsupported type "${type}" for field "${key}" in flex model schema.`);
             }
             FlexModelFieldValidTypes[key] = validTypes;
         }
@@ -671,14 +675,24 @@ <h5 class="modal-title pe-2">Edit {{ asset.name }}'s flex-model</h5>
 
             async function renderSelectInfoCards(modelKey, allowedUnits = []) {
                 if (modelKey) {
+                    const storageEfficiencyWarning = modelKey === "storage-efficiency"
+                        ? `
+                            <div class="pt-2 text-danger">
+                                <span class="fw-bold">Warning:</span> If you use a sensor, ensure its resolution matches the scheduling resolution. Currently there is no resampling using sensor resolution for this field.
+                            </div>
+                        `
+                        : "";
+
                     flexInfoContainer.innerHTML = `
                     <div>
                         <div class="alert alert-info" role="alert">
-                            <b> About ${getFlexFieldTitle(modelKey)}
+                            <strong>About ${getFlexFieldTitle(modelKey)}</strong>
                             <div class="pt-2 fw-normal">
                                 ${schemaSpecs[modelKey]["description"] || "No description available."}
                             </div>
 
+                            ${storageEfficiencyWarning}
+
                              <div class="pt-2 fw-bold"> 
                                 Possible types: <span class="fw-normal"> ${schemaSpecs[modelKey]["types"]["ui"] || "No types available."} </span> <br/>
                                 Example units: <span class="fw-normal"> ${schemaSpecs[modelKey]["example-units"].join(", ")} </span>