Feat/efficiencyfield support sensor

documentation/changelog.rst

@@ -24,7 +24,7 @@ Bugfixes
 * Make the sensor page load much faster for sensors with lots of data, by avoiding to load statistics over all of its history by default [see `PR #2129 <https://www.github.com/FlexMeasures/flexmeasures/pull/2129>`_]
 * Return a clear validation error (instead of a server ZeroDivisionError) when posting instantaneous (0-minute) data to non-instantaneous sensors via ``[POST] /sensors/(id)/data`` [see `PR #2116 <https://www.github.com/FlexMeasures/flexmeasures/pull/2116>`_]
 * Fix asset context page for asset names containing apostrophes [see `PR #2117 <https://www.github.com/FlexMeasures/flexmeasures/pull/2117>`_]
-
+* Support sensor references for efficiency fields in storage flex-models [see `PR #2142 <https://www.github.com/FlexMeasures/flexmeasures/pull/2142>`_]
 
 v0.32.1 | May XX, 2026
 ============================

flexmeasures/data/schemas/scheduling/__init__.py

@@ -658,35 +658,35 @@ def _to_currency_per_mwh(price_unit: str) -> str:
         "default": None,
         "description": rst_to_openapi(metadata.ROUNDTRIP_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"],
     },
     "charging-efficiency": {
         "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:
 
@@ -435,7 +436,8 @@ class DBStorageFlexModelSchema(Schema):
         metadata={"deprecated field": "soc-usage"},
     )
 
-    roundtrip_efficiency = EfficiencyField(
+    roundtrip_efficiency = VariableQuantityField(
+        "%",
         data_key="roundtrip-efficiency",
         required=False,
         metadata={"deprecated field": "roundtrip_efficiency"},
@@ -455,7 +457,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,34 @@ def test_get_variable_quantity_unit(
             {"soc-usage": ["3500 kW", {"sensor": "power-sensor"}]},
             False,
         ),
+        (
+            {"roundtrip-efficiency": {"sensor": "efficiency-sensor"}},
+            False,
+        ),
+        (
+            {"roundtrip-efficiency": {"sensor": "power-sensor"}},
+            {"roundtrip-efficiency": "Cannot convert 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
+):
     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/static/openapi-specs.json

@@ -4183,7 +4183,6 @@
     },
     "/api/v3_0": {},
     "/api/v3_0/sensors/data": {},
-    "/api/v3_0/docs/dist/{filename}": {},
     "/api/v3_0/docs/{path}": {},
     "/api/dev/sensor/{id}": {},
     "/api/dev/sensor/{id}/chart": {},

flexmeasures/ui/templates/assets/asset_properties.html

@@ -452,8 +452,6 @@ <h5 class="modal-title pe-2">Edit {{ asset.name }}'s flex-model</h5>
                 validTypes = [String, Object];
             } else if (type === "typeFour") {
                 validTypes = [Array];
-            } else if (type === "typeFive") {
-                validTypes = [String];
             }
             FlexModelFieldValidTypes[key] = validTypes;
         }