Volume Delta Expansion #1062

SteveMicroNova · 2025-10-24T13:21:55Z

What does this change intend to accomplish?

This PR aims to preserve the relative distance between zone volume levels when they would otherwise exceed the min or max vol_f

Checklist

Have you tested your changes and ensured they work?
Have you checked to ensure there aren't other open Pull Requests for the same update/change?
If applicable, have you updated the documentation/manual?
If applicable, have you updated the CHANGELOG?
Does your submission pass linting & tests? You can test on localhost using ./scripts/test
Have you written new tests for your core features/changes, as applicable?
If this is a UI change, have you tested it across multiple browser platforms on both desktop and mobile?

amplipi/models.py

SteveMicroNova · 2025-10-29T18:03:54Z

This has expanded to also include #1024 due to that being one extra line beyond what I'd already done to implement that for zones, though I then discovered it was an extra chunk to App.jsx to do the same for groups so there was some slight feature creep to this PR there.

codecov-commenter · 2025-10-29T20:36:45Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 50.25%. Comparing base (7499989) to head (6c049a5).
⚠️ Report is 80 commits behind head on main.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1062      +/-   ##
==========================================
- Coverage   50.67%   50.25%   -0.42%     
==========================================
  Files          40       41       +1     
  Lines        7154     7368     +214     
==========================================
+ Hits         3625     3703      +78     
- Misses       3529     3665     +136

Flag	Coverage Δ
unittests	`50.25% <100.00%> (-0.42%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

SteveMicroNova · 2025-11-07T16:24:30Z

This does not interfere with home assistant's functionality

amplipi/ctrl.py

amplipi/models.py

amplipi/ctrl.py

amplipi/models.py

linknum23

The changes here look pretty reasonable. As this is an API change we should add one or more tests (or update pre-existing ones) right?

SteveMicroNova · 2025-12-01T20:55:48Z

tests/test_rest.py

+      assert z['vol_f'] - (zones[z['id']]['vol_f'] + 0.1) < 0.0001 and z["vol_f_overflow"] == 0

-  # test oversized deltas
-  rv = client.patch('/api/zones', json={'zones': [z['id'] for z in zones], 'update': {'vol_delta_f': -10.0}})
+  # test overflowing deltas
+  rv = client.patch('/api/zones', json={'zones': [z['id'] for z in zones], 'update': {'vol_delta_f': -1.0}})
  assert rv.status_code == HTTPStatus.OK
  jrv = rv.json()
  assert len(jrv['zones']) >= 6
  # check that each update worked as expected
  for z in jrv['zones']:
    if z['id'] in range(6):
      assert z['vol_f'] == amplipi.models.MIN_VOL_F
+      assert z["vol_f_overflow"] == zones[z['id']]['vol_f'] + 0.1 - 1
+
+  # test oversized overflowing deltas
+  rv = client.patch('/api/zones', json={'zones': [z['id'] for z in zones], 'update': {'vol_delta_f': 10.0}})
+  assert rv.status_code == HTTPStatus.OK
+  jrv = rv.json()
+  assert len(jrv['zones']) >= 6
+  # check that each update worked as expected
+  for z in jrv['zones']:
+    if z['id'] in range(6):
+      assert z['vol_f'] == amplipi.models.MAX_VOL_F
+      assert z["vol_f_overflow"] == amplipi.models.MAX_VOL_F_OVERFLOW
+
+  # test overflow reset
+  mid_vol_f = (amplipi.models.MIN_VOL_F + amplipi.models.MAX_VOL_F) / 2
+  rv = client.patch('/api/zones', json={'zones': [z['id'] for z in zones], 'update': {'vol_f': mid_vol_f}})
+  assert rv.status_code == HTTPStatus.OK
+  jrv = rv.json()
+  assert len(jrv['zones']) >= 6
+  # check that each update worked as expected
+  for z in jrv['zones']:
+    if z['id'] in range(6):
+      assert z['vol_f'] == mid_vol_f
+      assert z["vol_f_overflow"] == 0


Changed this test to account for valid overflows, oversized overflows, and overflow resets

amplipi/ctrl.py

web/src/App.jsx

SteveMicroNova · 2025-12-12T22:27:33Z

There's some jittering in this yet, not due to this PR but exacerbated by it. The origin of this jitter is that we send volume change requests while sliding the slider but not all of the delta is always realized during that due to a race condition. A few solutions to this:

Only recognize on mouse up - This loses the ability to hear changes as you scroll
Convert the volume change call to be some sort of loop that goes while cumulativeDelta is not 0 as to not miss any user input - This seems complicated, not nearly as useful as python would make it. Potentially better to solve our queuing problem in the backend if this is the chosen path

There's also some potential that the jitter is due to javascript only having floats for decimal values, which would mean we have to fix this by rounding every single instance of a float vol everywhere to see this fixed

Add more values to models.py to track the min and max overflow

…and"

…eSlider

SteveMicroNova · 2025-12-15T19:59:06Z

I'm going to refrain from rebasing #1063 and #1071 until we're happy with the volume slider functionality here, so those will not be worth reviewing until that is the case

SteveMicroNova linked an issue Oct 29, 2025 that may be closed by this pull request

Add min/max volume buffers #1061

Open

SteveMicroNova marked this pull request as ready for review October 29, 2025 16:41

SteveMicroNova commented Oct 29, 2025

View reviewed changes

amplipi/models.py Show resolved Hide resolved

SteveMicroNova linked an issue Oct 29, 2025 that may be closed by this pull request

Set child mute status on the frontend #1024

Open

SteveMicroNova requested a review from linknum23 October 29, 2025 19:42

SteveMicroNova force-pushed the VolumeDeltaExpansion branch from 0bb2671 to 31dc4ab Compare October 29, 2025 19:50

SteveMicroNova force-pushed the VolumeDeltaExpansion branch from b2379f0 to eea75bb Compare November 7, 2025 19:21

linknum23 reviewed Nov 7, 2025

View reviewed changes

amplipi/ctrl.py Show resolved Hide resolved

linknum23 reviewed Nov 7, 2025

View reviewed changes

amplipi/models.py Outdated Show resolved Hide resolved

SteveMicroNova commented Nov 7, 2025

View reviewed changes

amplipi/ctrl.py Outdated Show resolved Hide resolved

SteveMicroNova commented Nov 7, 2025

View reviewed changes

amplipi/ctrl.py Outdated Show resolved Hide resolved

SteveMicroNova commented Nov 7, 2025

View reviewed changes

amplipi/ctrl.py Show resolved Hide resolved

SteveMicroNova force-pushed the VolumeDeltaExpansion branch from db7f047 to 54fda80 Compare November 17, 2025 21:08

SteveMicroNova requested a review from linknum23 November 25, 2025 15:48

SteveMicroNova commented Nov 26, 2025

View reviewed changes

amplipi/ctrl.py Outdated Show resolved Hide resolved

SteveMicroNova commented Nov 26, 2025

View reviewed changes

amplipi/models.py Outdated Show resolved Hide resolved

SteveMicroNova force-pushed the VolumeDeltaExpansion branch from 94e796e to f067d19 Compare November 26, 2025 17:39

linknum23 requested changes Dec 1, 2025

View reviewed changes

SteveMicroNova commented Dec 1, 2025

View reviewed changes

SteveMicroNova requested a review from linknum23 December 1, 2025 20:55

SteveMicroNova force-pushed the VolumeDeltaExpansion branch from 8888e3c to 6fc3b89 Compare December 2, 2025 17:53