FlexMeasures / flexmeasures / 22913751043

78%

push

github

Support saving state-of-charge schedules to sensors with % unit (#1996)

* Initial plan

* feat: support saving SOC schedules to sensors with '%' unit

- Add _build_soc_schedule() helper in StorageScheduler to handle % unit
  conversion using soc-max as capacity; skip with warning if soc-max is
  missing or zero
- Add additional_sensor_units parameter to VariableQuantityField to allow
  sensors with extra units (e.g. %) beyond to_unit-compatible ones
- Allow % sensors for state_of_charge field in StorageFlexModelSchema and
  DBStorageFlexModelSchema
- Fix _validate_energy_fields in DBStorageFlexModelSchema to accept %
  sensors for state_of_charge
- Update STATE_OF_CHARGE metadata description to document % unit support
- Add test_save_state_of_charge_percent_sensor covering both save and skip
- Add changelog entry

Co-authored-by: Flix6x <30658763+Flix6x@users.noreply.github.com>

* refactor: address coordinator review feedback

- Make _build_soc_schedule a @staticmethod (no instance state used)
- Add defensive isinstance(soc_max, Sensor) guard against future
  VariableQuantityField usage for soc-max
- Improve additional_sensor_units docstring to clarify intended use

Co-authored-by: Flix6x <30658763+Flix6x@users.noreply.github.com>

* fix: address review feedback on PR #1996

- Fix PR number in changelog (2002 → 1996)
- Regenerate openapi-specs.json to include updated STATE_OF_CHARGE
  field description
- Redesign test_save_state_of_charge_percent_sensor to verify specific
  SOC percentage values: starting full with 50% storage efficiency gives
  idle-decay pattern 100→50→25→12.5%, plus soc-minima at t+60min=8%
  forces charging and confirms the conversion math
- Split into two focused test functions: positive case with value
  assertions and a separate skip-when-zero-soc-max case
- Drop redundant resolution=timedelta(0) from search_beliefs() call
  (sensor has event_resolution=0, so no resampling occurs either way)

Co-authored-by: Flix6x <30658763+... (continued)

1656 of 2174 branches covered (76.17%)

Branch coverage included in aggregate %.

25 of 28 new or added lines in 3 files covered. (89.29%)

11315 of 14441 relevant lines covered (78.35%)

1.57 hits per line