Feat/efficiencyfield support sensor by joshuaunity · Pull Request #2142 · FlexMeasures/flexmeasures

joshuaunity · 2026-04-29T08:53:09Z

Description

This PR extends the support for efficiency-based sensors on the flex-model efficiency fields.

Look & Feel

Before

After

How to test

Open up an assets flex-model modal dialogue
Look for an efficiency if one is already added, or add a new one
Observe that the "sensor" input tab is now available
Search and add a sensor field
Observe if it successfully updates the modal without any errors

Further Improvements

None

Related Items

This PR closes #2123

Sign-off

I agree to contribute to the project under Apache 2 License.
To the best of my knowledge, the proposed patch is not based on code under GPL or other license that is incompatible with FlexMeasures

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

read-the-docs-community · 2026-04-29T08:56:17Z

Documentation build overview

📚 flexmeasures | 🛠️ Build #32469607 | 📁 Comparing 0ca0340 against latest (1b609bd)

🔍 Preview build

3 files changed

± changelog.html
± _autosummary/flexmeasures.data.schemas.scheduling.storage.html
± api/v3_0.html

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Copilot

Pull request overview

This PR extends the storage flex-model configuration (UI + schema/OpenAPI) to allow efficiency fields to be set via sensor references (dynamic signals), aligning with issue #2123.

Changes:

Update flex-model schema metadata and UI typing to treat efficiency fields as variable quantities (fixed value or sensor reference).
Refactor EfficiencyField to support sensor references and add/extend schema validation tests for efficiency sensors.
Regenerate/update OpenAPI specs and add a changelog entry documenting the feature.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
flexmeasures/ui/templates/assets/asset_properties.html	Removes `typeFive` handling so UI backend-types map cleanly to remaining type categories (enabling sensor tab for efficiency fields).
flexmeasures/ui/static/openapi-specs.json	Updates OpenAPI schema for roundtrip-efficiency to use `VariableQuantityOpenAPI`, but also includes an unintended `info.version` regression.
flexmeasures/data/schemas/tests/test_scheduling.py	Adds DB flex-model schema tests for efficiency sensor references and unit convertibility checks.
flexmeasures/data/schemas/scheduling/storage.py	Changes `EfficiencyField` to a `VariableQuantityField` (sensor-capable), but introduces downstream/runtime + doctest issues.
flexmeasures/data/schemas/scheduling/init.py	Changes efficiency fields’ metadata to “fixed or sensor” in the flex-model schema exposed to the UI.
documentation/changelog.rst	Adds a changelog bullet for efficiency sensor references in storage flex-models.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: JDev <45713692+joshuaunity@users.noreply.github.com>

…just related schema fields Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Agent-Logs-Url: https://github.com/FlexMeasures/flexmeasures/sessions/78236b92-a722-4d40-b912-cae162ad3db4 Co-authored-by: joshuaunity <45713692+joshuaunity@users.noreply.github.com>

nhoening

It seems to work well (I tested the flex-model dialogue for a bit).

Two smaller comments from my side that can be fixed easily by @joshuaunity .

I am not sure if @Flix6x wants to see this, as well.

There is a comment in the issue about testing if the feature set between UI and schema diverges, but it is not specified well yet, and does not need to be part of this PR IMO.

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

…Measures/flexmeasures into feat/efficiencyfield-support-sensor

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Flix6x

Nice to see this PR. I think copilot's review deserves another look. I think it correctly flagged that the roundtrip-efficiency field is problematic. Imo it should simply be reverted.

For the storage-efficiency field, the sensor reference is also not without issue, because we are still lacking logic to resample the efficiency from the sensor resolution to the scheduling resolution. I think we should add something of a warning in the UI (info marker?) when the user is about to select (and/or has selected) a sensor for the storage-efficiency. Not sure what a good text is yet. I do like that this field can now be a sensor, too, though!

joshuaunity · 2026-05-04T07:46:18Z

I think we should add something of a warning in the UI

I can do that.

joshuaunity · 2026-05-04T13:25:09Z

@Flix6x what do you think?

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Flix6x · 2026-05-04T17:58:29Z

@Flix6x what do you think?

Nailed it! 👌

Signed-off-by: JDev <45713692+joshuaunity@users.noreply.github.com>

joshuaunity · 2026-05-05T10:34:01Z

@nhoening, this can be merged if there are no more requests.

nhoening · 2026-05-05T11:13:06Z

@Flix6x do you approve?

Signed-off-by: JDev <45713692+joshuaunity@users.noreply.github.com>

Flix6x

No! Please address my review comments, and not just click resolve.

Flix6x · 2026-05-06T09:24:57Z

Please do not prompt me for a review again before commenting on each of my review comments.

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Signed-off-by: JDev <45713692+joshuaunity@users.noreply.github.com>

joshuaunity · 2026-05-06T11:08:17Z

https://github.com/FlexMeasures/flexmeasures/blob/main/flexmeasures%2Fdata%2Fmodels%2Fplanning%2Fstorage.py#L870-L881

Looking at this, the roundtrip_efficiency can't work with sensors at all at the moment. I'm looking at the other fields as well to see if any also fall into a similar situation.

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Signed-off-by: JDev <45713692+joshuaunity@users.noreply.github.com>

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Signed-off-by: JDev <45713692+joshuaunity@users.noreply.github.com>

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

joshuaunity · 2026-05-18T14:32:39Z

@Flix6x, I've looked over the comments and attended to them.

Flix6x

Great. I only have tiny requests to finish up the PR.

Flix6x · 2026-05-18T15:37:57Z

    )

-    storage_efficiency = EfficiencyField(
+    storage_efficiency = VariableQuantityField(


Is there no associated change to the openapi-specs.json?

No, I don't think they should, as the flex-config schema isn't directly placed on the API's themselves, rather they are used under the hood.

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Flix6x

Thanks!

joshuaunity added 2 commits April 29, 2026 09:47

refactor: update efficiency field and types in scheduling schemas

31f8281

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

test: add tests for efficiency sensors in DBFlexModelSchema

b599e43

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

joshuaunity self-assigned this Apr 29, 2026

chore: add changelog entry

cf0edab

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

joshuaunity requested a review from Copilot April 29, 2026 08:59

Copilot started reviewing on behalf of joshuaunity April 29, 2026 08:59 View session

joshuaunity added the enhancement New feature or request label Apr 29, 2026

Copilot AI reviewed Apr 29, 2026

View reviewed changes

joshuaunity and others added 4 commits April 29, 2026 10:09

Update flexmeasures/data/schemas/scheduling/storage.py

f0fc4c5

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: JDev <45713692+joshuaunity@users.noreply.github.com>

Update flexmeasures/data/schemas/scheduling/storage.py

7772bc2

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: JDev <45713692+joshuaunity@users.noreply.github.com>

Update flexmeasures/ui/static/openapi-specs.json

9c72835

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: JDev <45713692+joshuaunity@users.noreply.github.com>

refactor: update EfficiencyField to inherit from QuantityField and ad…

7a2925a

…just related schema fields Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Copilot started work on behalf of joshuaunity April 29, 2026 09:42 View session

joshuaunity requested a review from nhoening April 29, 2026 09:42

fix: restore openapi-specs.json version to 0.32.0

9e00754

Agent-Logs-Url: https://github.com/FlexMeasures/flexmeasures/sessions/78236b92-a722-4d40-b912-cae162ad3db4 Co-authored-by: joshuaunity <45713692+joshuaunity@users.noreply.github.com>

Copilot finished work on behalf of joshuaunity April 29, 2026 09:52

nhoening approved these changes Apr 29, 2026

View reviewed changes

Comment thread documentation/changelog.rst Outdated

Comment thread flexmeasures/data/schemas/tests/test_scheduling.py

joshuaunity added 3 commits April 29, 2026 15:41

test: enhance DB storage flex-model schema tests for sensor references

6ab9798

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Merge branch 'feat/efficiencyfield-support-sensor' of github.com:Flex…

85a2cb0

…Measures/flexmeasures into feat/efficiencyfield-support-sensor

chore: udpated docstring

0ca0340

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Flix6x requested changes Apr 29, 2026

View reviewed changes

Comment thread flexmeasures/data/schemas/scheduling/storage.py

Comment thread flexmeasures/data/schemas/scheduling/__init__.py

Comment thread flexmeasures/data/schemas/scheduling/__init__.py

feat: add warning for sensor resolution in storage efficiency info cards

f5f8d50

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Merge branch 'main' into feat/efficiencyfield-support-sensor

3f57300

Signed-off-by: JDev <45713692+joshuaunity@users.noreply.github.com>

Merge branch 'main' into feat/efficiencyfield-support-sensor

057461e

Signed-off-by: JDev <45713692+joshuaunity@users.noreply.github.com>

Flix6x added this to the 0.33.0 milestone May 6, 2026

Flix6x requested changes May 6, 2026

View reviewed changes

Comment thread documentation/changelog.rst Outdated

Comment thread flexmeasures/ui/static/openapi-specs.json Outdated

Comment thread flexmeasures/data/schemas/scheduling/__init__.py

joshuaunity and others added 2 commits May 6, 2026 10:59

chore: resolving changelog conflicts

0efacb1

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Update API version to 0.32.0

025bf3d

Signed-off-by: JDev <45713692+joshuaunity@users.noreply.github.com>

joshuaunity and others added 5 commits May 7, 2026 08:46

feat: update roundtrip efficiency field type and schema description

1a213b4

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Update API version to 0.32.0

18d2369

Signed-off-by: JDev <45713692+joshuaunity@users.noreply.github.com>

chore: refactored test cases

40a055e

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Merge branch 'main' into feat/efficiencyfield-support-sensor

abe7c1e

Signed-off-by: JDev <45713692+joshuaunity@users.noreply.github.com>

fix: added support for string only field types

23c6ea0

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Flix6x requested changes May 18, 2026

View reviewed changes

chore: revert few changes

b0ff94a

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Flix6x approved these changes May 19, 2026

View reviewed changes

Flix6x merged commit 2831ca4 into main May 19, 2026
12 checks passed

Flix6x deleted the feat/efficiencyfield-support-sensor branch May 19, 2026 10:05

Uh oh!

Conversation

joshuaunity commented Apr 29, 2026

Description

Look & Feel

How to test

Further Improvements

Related Items

Sign-off

Uh oh!

read-the-docs-community Bot commented Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation build overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nhoening left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Flix6x left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

joshuaunity commented May 4, 2026

Uh oh!

joshuaunity commented May 4, 2026

Uh oh!

Flix6x commented May 4, 2026

Uh oh!

joshuaunity commented May 5, 2026

Uh oh!

nhoening commented May 5, 2026

Uh oh!

Flix6x left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Flix6x commented May 6, 2026

Uh oh!

joshuaunity commented May 6, 2026

Uh oh!

joshuaunity commented May 18, 2026

Uh oh!

Flix6x left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Flix6x May 18, 2026

Choose a reason for hiding this comment

Uh oh!

joshuaunity May 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Flix6x left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

read-the-docs-community Bot commented Apr 29, 2026 •

edited

Loading

nhoening left a comment •

edited

Loading

joshuaunity May 19, 2026 •

edited

Loading