feat: Adapting flex-config to SensorsToShowSchema

documentation/changelog.rst

@@ -25,6 +25,8 @@ New features
 * Give ability to edit sensor timezone from the UI [see `PR #1900 <https://www.github.com/FlexMeasures/flexmeasures/pull/1900>`_]
 * Support creating schedules with only information known prior to some time, now also via the CLI (the API already supported it) [see `PR #1871 <https://www.github.com/FlexMeasures/flexmeasures/pull/1871>`_].
 * Add ``fields`` param to the asset-listing endpoints, to save bandwidth in response data [see `PR #1884 <https://www.github.com/FlexMeasures/flexmeasures/pull/1884>`_]
+* Support for flex-config in the ``SensorsToShowSchema`` [see `PR #1904 <https://www.github.com/FlexMeasures/flexmeasures/pull/1904>`_]
+
 
   .. note:: For backwards-compatibility, the new ``fields`` parameter will only be fully active, i.e. also returning less fields per default, in v0.32. Set ``FLEXMEASURES_API_SUNSET_ACTIVE=True`` to test the full effect now.
 

documentation/views/asset-data.rst

@@ -108,19 +108,20 @@ Editing the graphs dashboard
 
 Click the "Edit Graph" button to open the graph editor.
 
-Use the "Add Graph" button to create graphs. For each graph, you can select one or more sensors, from all available sensors associated with the asset, including public sensors, and add them to your plot.  
+Use the "Add Graph" button to create graphs. For each graph, you can select one or more sensors, from all available sensors associated with the asset, including public sensors, and add them to your plot.
 
-You can overlay data from multiple sensors on a single graph. To do this, click on an existing plot and add more sensors from the available options on the right. 
+In addition, you can add an asset's flex-config to the graph, as long as the value of that config is a sensor(e.g. `[{"title":"Power","plots":[{"sensor":2}]},{"title":"Costs","plots":[{"sensors":[5,6]}]}]`).
 
-Finally, it is possible to set custom titles for any sensor graph by clicking on the "edit" button right next to the default or current title.
+Finally, it is possible to set custom titles for any graph by clicking on the "edit" button right next to the default or current title.
 
 .. image:: https://github.com/FlexMeasures/screenshots/raw/main/screenshot-asset-editgraph.png
     :align: center
 ..    :scale: 40%
 
 |
 
-Internally, the asset has a `sensors_to_show` field, which controls which sensor data appears in the plot. This can also be set by a script. The accepted format is a dictionary with a graph title and a lists of sensor IDs (e.g. `[{"title": "Power", "sensor": 2}, {"title": "Costs", "sensors": [5,6] }]`).
+Internally, the asset has a `sensors_to_show` field, which controls which sensor data appears in the plot. This can also be set by a script or through the API. 
+The accepted format is a dictionary with a graph title followed by a plot containing senors or asset fex-config reference(e.g. `[{"title":"Power","plots":[{"sensor":2}]},{"title":"Costs","plots":[{"sensor":5},{"asset":10,"flex-model":"soc-min"},]}]`).
 
 
 Showing daily KPIs

flexmeasures/cli/data_add.py

@@ -1824,19 +1824,23 @@ def create_asset_with_one_sensor(
         db.session.flush()
         battery = discharging_sensor.generic_asset
         battery.sensors_to_show = [
-            {"title": "Prices", "sensor": day_ahead_sensor.id},
+            {"title": "Prices", "plots": [{"sensor": day_ahead_sensor.id}]},
             {
                 "title": "Power flows",
-                "sensors": [production_sensor.id, discharging_sensor.id],
+                "plots": [
+                    {"sensors": [production_sensor.id, discharging_sensor.id]},
+                ],
             },
         ]
 
         # the site gets a similar dashboard (TODO: after #1801, add also capacity constraint)
         building_asset.sensors_to_show = [
-            {"title": "Prices", "sensor": day_ahead_sensor.id},
+            {"title": "Prices", "plots": [{"sensor": day_ahead_sensor.id}]},
             {
                 "title": "Power flows",
-                "sensors": [production_sensor.id, discharging_sensor.id],
+                "plots": [
+                    {"sensors": [production_sensor.id, discharging_sensor.id]},
+                ],
             },
         ]
 
@@ -1876,10 +1880,10 @@ def create_asset_with_one_sensor(
 
         process = shiftable_power.generic_asset
         process.sensors_to_show = [
-            {"title": "Prices", "sensor": day_ahead_sensor.id},
-            {"title": "Inflexible", "sensor": inflexible_power.id},
-            {"title": "Breakable", "sensor": breakable_power.id},
-            {"title": "Shiftable", "sensor": shiftable_power.id},
+            {"title": "Prices", "plots": [{"sensor": day_ahead_sensor.id}]},
+            {"title": "Inflexible", "plots": [{"sensor": inflexible_power.id}]},
+            {"title": "Breakable", "plots": [{"sensor": breakable_power.id}]},
+            {"title": "Shiftable", "plots": [{"sensor": shiftable_power.id}]},
         ]
 
         db.session.commit()

flexmeasures/data/models/charts/belief_charts.py

@@ -528,7 +528,14 @@ def chart_for_multiple_sensors(
         title = entry.get("title")
         if title == "Charge Point sessions":
             continue
-        sensors = entry.get("sensors")
+        plots = entry.get("plots", [])
+        sensors = []
+        for plot in plots:
+            if "sensors" in plot:
+                sensors.extend(plot.get("sensors"))
+            elif "sensor" in plot:
+                sensors.extend([plot.get("sensor")])
+
         # List the sensors that go into one row
         row_sensors: list["Sensor"] = sensors  # noqa F821
 

flexmeasures/data/models/generic_assets.py

@@ -234,7 +234,7 @@ def validate_sensors_to_show(
         Steps:
         - The function deserializes the 'sensors_to_show' data from the database, ensuring that older formats are parsed correctly.
         - It checks if each sensor is accessible by the user and filters out any unauthorized sensors.
-        - The sensor structure is rebuilt according to the latest format, which allows for grouping sensors and adding optional titles.
+        - The sensor structure is rebuilt according to the latest format, which allows for grouping sensors and adding optional titles, all into a single 'plots' array.
 
         Details on format:
         - The 'sensors_to_show' attribute is defined as a list of sensor IDs or nested lists of sensor IDs (to indicate grouping).
@@ -247,8 +247,8 @@ def validate_sensors_to_show(
 
         2. List with titles and sensor groupings:
             sensors_to_show = [
-                {"title": "Title 1", "sensor": 40},
-                {"title": "Title 2", "sensors": [41, 42]},
+                {"title": "Title 1", "plots": [{"sensor": 40}]},
+                {"title": "Title 2", "plots": [{"sensors": [41, 42]}]},
                 [43, 44], 45, 46
             ]
 
@@ -287,6 +287,7 @@ def validate_sensors_to_show(
 
         sensor_ids_to_show = self.sensors_to_show
         # Import the schema for validation
+        from flexmeasures.data.schemas.utils import extract_sensors_from_flex_config
         from flexmeasures.data.schemas.generic_assets import SensorsToShowSchema
 
         sensors_to_show_schema = SensorsToShowSchema()
@@ -324,7 +325,17 @@ def validate_sensors_to_show(
         for entry in standardized_sensors_to_show:
 
             title = entry.get("title")
-            sensors = entry.get("sensors")
+            sensors = []
+            plots = entry.get("plots", [])
+            if len(plots) > 0:
+                for plot in plots:
+                    if "sensor" in plot:
+                        sensors.append(plot["sensor"])
+                    if "sensors" in plot:
+                        sensors.extend(plot["sensors"])
+                    if "asset" in plot:
+                        extracted_sensors = extract_sensors_from_flex_config(plot)
+                        sensors.extend(extracted_sensors)
 
             accessible_sensors = [
                 accessible_sensor_map.get(sid)
@@ -334,7 +345,9 @@ def validate_sensors_to_show(
             inaccessible = [sid for sid in sensors if sid not in accessible_sensor_map]
             missed_sensor_ids.extend(inaccessible)
             if accessible_sensors:
-                sensors_to_show.append({"title": title, "sensors": accessible_sensors})
+                sensors_to_show.append(
+                    {"title": title, "plots": [{"sensors": accessible_sensors}]}
+                )
 
         if missed_sensor_ids:
             current_app.logger.warning(