Skip to content

Commit 0d3cac3

Browse files
committed
Release HOMEii Music Flow 5.9.0
1 parent 73b0cbd commit 0d3cac3

23 files changed

Lines changed: 3141 additions & 776 deletions

CHANGELOG.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Changelog
22

3-
## 5.9.0-local - Unreleased
3+
## 5.9.0 - 2026-06-03
44

5-
Local development baseline for the next 5.9.0 release.
5+
Major mobile, diagnostics, settings, and community release after the 5.8.x stabilization cycle.
66

77
Added:
88

@@ -11,11 +11,35 @@ Added:
1111
- `card_id` validator and visual-editor field in the Connection And Behavior section.
1212
- Settings accordion sections for Display, Players & Library, Quick Actions & Bar, Voice Assistant, Smart Home & Screensaver, Announcements, and Music Assistant.
1313
- Targeted Settings refresh path for high-frequency toggles so pinned/excluded players, Quick Actions, footer/main bar items, library tabs, player sort/order, screensaver controls, and discovery mode no longer rebuild the whole card on every click.
14+
- Query-string player override support through `?player=kitchen_sonos`, `?homeii_player=kitchen_sonos`, and card-scoped `?homeii_player_<card_id>=kitchen_sonos` links.
15+
- Optional phone edge-to-edge mode so the normal mobile layout can occupy the full viewport and open menus as frontmost full-screen layers.
16+
- Fast Queue Flow is now part of the default mobile Quick Actions set, while still removable from Quick Actions when a user does not want it.
17+
- A clearer Players screen action hub with four icon-and-text actions: This device, Queue, Groups, and Clear all.
18+
- Phone display mode now exposes Edge to edge as part of the layout-mode choice instead of a separate toggle, with a top X button that returns the card to Full mode.
19+
- Queue includes a dedicated Fast Queue Flow entry button and a distinct queue-flow icon.
20+
- Library pages now offer the same vertical wheel browsing style for playlists, artists, albums, tracks, liked items, radio stations, and artist-detail albums.
21+
- Artist album wheel opens as a dedicated full-screen Queue Flow-style page with its own close button instead of rendering inside the artist albums section.
1422

1523
Migration note:
1624

1725
- Adding `card_id` to a card that previously had no `card_id` will appear to reset that card's in-card customizations once. The old global values stay in localStorage under their original keys; the card just starts reading from card-scoped keys.
1826

27+
Fixed:
28+
29+
- Preserves complete queue snapshots when Home Assistant first returns a partial or empty queue after starting a playlist, avoiding the beta 8 regression where only one or two tracks appeared.
30+
- Visual-editor diagnostics on mobile now still shows the diagnostic report when the HA Companion/browser blocks clipboard access; copy failure is reported as a warning instead of replacing the report.
31+
- The player-selected toast now appears near the top so it does not cover the volume slider.
32+
- Full-screen mobile sheets and menus receive edge-to-edge sizing in phone edge-to-edge mode, reducing layer overlap between controls.
33+
- Visual-editor diagnostics uses explicit readable colors so Home Assistant theme variables cannot produce low-contrast text.
34+
- Visual-editor player settings list strict Music Assistant players instead of every generic Home Assistant `media_player`, while preserving already configured legacy ids.
35+
- Danish localization placeholder fixes from PR #56 so runtime variables such as `{player}`, `{title}`, `{count}`, and `{remaining}` resolve correctly.
36+
- Mobile library toolbar keeps the Library Wheel button compact so it does not overlap search, sort, player focus, or quick action buttons on phone-width screens.
37+
- Radio and artist-album wheel pages now use a single Queue Flow-style scroll stage, with cleaner captions for album year and station name.
38+
39+
Community credits:
40+
41+
- Thanks @tocDK for the Danish localization work and the PR ideas around `card_id`, settings performance, artwork cache behavior, and follow-up Danish placeholder fixes that were incorporated into 5.9.0.
42+
1943
## 5.8.2-beta.8 - 2026-06-03
2044

2145
Focused beta follow-up for issue #28 after beta 7 exposed the next Home Assistant service-call layer.

README.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,14 @@ https://github.com/user-attachments/assets/a0076e6e-0352-40f8-ac37-35737e717a80
4040
<a href="https://www.hacs.xyz/docs/use/download/download/">
4141
<img alt="Install HACS" src="https://img.shields.io/badge/Install-HACS-41BDF5?logo=homeassistant&logoColor=white">
4242
</a>
43-
<a href="https://github.com/r11a/homeii-music-flow/archive/refs/tags/v5.8.1.zip">
44-
<img alt="Download HOMEii Flow 5.8.1 stable tag archive" src="https://img.shields.io/badge/Download-v5.8.1%20stable-111111?logo=github">
43+
<a href="https://github.com/r11a/homeii-music-flow/archive/refs/tags/v5.9.0.zip">
44+
<img alt="Download HOMEii Flow 5.9.0 stable tag archive" src="https://img.shields.io/badge/Download-v5.9.0%20stable-111111?logo=github">
4545
</a>
4646
</p>
4747

4848
<p align="center">
49-
<a href="https://github.com/r11a/homeii-music-flow"><img alt="stable version" src="https://img.shields.io/badge/stable-5.8.1-gold"></a>
50-
<a href="https://github.com/r11a/homeii-music-flow/releases/tag/v5.8.2-beta.8"><img alt="beta version" src="https://img.shields.io/badge/beta-5.8.2--beta.8-8A63D2"></a>
49+
<a href="https://github.com/r11a/homeii-music-flow/releases/tag/v5.9.0"><img alt="stable version" src="https://img.shields.io/badge/stable-5.9.0-gold"></a>
50+
<a href="https://github.com/r11a/homeii-music-flow/releases/tag/v5.9.0"><img alt="release notes" src="https://img.shields.io/badge/release%20notes-5.9.0-8A63D2"></a>
5151
<img alt="Home Assistant" src="https://img.shields.io/badge/Home%20Assistant-Dashboard-41BDF5">
5252
<img alt="Music Assistant" src="https://img.shields.io/badge/Music%20Assistant-required-7C5CFF">
5353
<img alt="Sendspin" src="https://img.shields.io/badge/Sendspin-browser%20player-18B6FF">
@@ -63,23 +63,23 @@ HOMEii Flow is a custom Home Assistant Dashboard card for Music Assistant. It tu
6363

6464
HOMEii Flow started from my own daily use of Home Assistant and Music Assistant. I wanted it to feel less like a technical dashboard widget and more like a real music app inside Home Assistant, so a lot of thought went into the flow, touch interactions, Hebrew/RTL comfort, wall-tablet behavior, mobile details, and the small moments that make choosing music feel natural at home.
6565

66-
## 5.8.2 Beta 8
66+
## 5.9.0 Release
6767

68-
HOMEii Flow 5.8.2 Beta 8 is a focused follow-up for issue #28 after the beta 7 diagnostics exposed the next service-call layer.
68+
HOMEii Flow 5.9.0 is a major mobile and reliability release. It graduates the 5.8.2 beta fixes, adds the new Library Wheel experience, expands Diagnostics v3, improves phone edge-to-edge behavior, and brings community PR ideas into the stable package.
6969

70-
- Keeps the beta 7 integration signal fallback, but now still passes the discovered `config_entry_id` to Home Assistant `music_assistant` service calls when those services require it.
71-
- Fixes library/service calls that failed with `required key not provided @ data['config_entry_id']` in some Home Assistant / Music Assistant setups.
72-
- Removes `queue_id` from the Home Assistant `music_assistant.get_queue` diagnostic path so HA only receives the selected `entity_id`.
73-
- Improves Diagnostic v3 wording for generic HA fallback players so Alexa/other `media_player` entities are not described as strict Music Assistant-marked players.
74-
- Makes queue diagnostics less fatal when the selected fallback player has no `active_queue` / `queue_id` identity.
75-
- Keeps the Beta 1 through Beta 7 artwork, Music Assistant compatibility, Danish localization, diagnostics, and performance fixes.
70+
Release headlines:
7671

77-
Beta download: [v5.8.2-beta.8](https://github.com/r11a/homeii-music-flow/releases/tag/v5.8.2-beta.8)
72+
- **Library Wheel and Queue Wheel:** a fast vertical wheel browser is now available for playlists, artists, albums, tracks, liked items, radio stations, and artist albums. Artist-album and radio wheel pages use a single Queue Flow-style scroll stage with clean captions.
73+
- **Diagnostics v3 is now a first-class support tool:** run it from the card settings or the visual editor to check Home Assistant, Music Assistant services, config entries, selected players, queue providers, library providers, Direct API, Sendspin readiness, browser context, and artwork paths.
74+
- **Phone edge-to-edge mode:** the normal mobile layout can now use a frontmost full-screen experience, with full-screen menus that avoid layered button overlap.
75+
- **Reusable dashboards:** `card_id` isolates per-card settings, and query-string player overrides such as `?player=kitchen_sonos` make shared dashboard includes easier.
76+
- **Settings and performance polish:** settings are organized into accordion sections, frequent toggles refresh surgically, and artwork cache behavior adapts better to performance profiles.
77+
- **Community localization:** Danish localization is included, with follow-up placeholder fixes so runtime variables render correctly.
7878

79-
Stable users can remain on 5.8.1. Beta users should hard refresh Home Assistant or use:
79+
Install or hard-refresh with:
8080

8181
```text
82-
/local/community/homeii-music-flow/homeii-music-flow.js?v=5.8.2-beta.8
82+
/local/community/homeii-music-flow/homeii-music-flow.js?v=5.9.0
8383
```
8484

8585
## 5.8.1 Hotfix Release
@@ -362,7 +362,7 @@ If HACS does not add the resource automatically, add:
362362
3. Add this Dashboard resource:
363363

364364
```text
365-
/local/community/homeii-music-flow/homeii-music-flow.js?v=5.8.1
365+
/local/community/homeii-music-flow/homeii-music-flow.js?v=5.9.0
366366
```
367367

368368
4. Add the card:
@@ -1049,7 +1049,8 @@ src/core/ extracted foundation helpers
10491049
src/config/ config validators
10501050
tests/ regression coverage
10511051
scripts/release.mjs release sync tooling
1052-
RELEASE_NOTES_5.8.2-beta.8.md detailed GitHub release notes for the current beta
1052+
RELEASE_NOTES_5.9.0.md detailed GitHub release notes for the current stable release
1053+
RELEASE_NOTES_5.8.2-beta.8.md previous beta release notes
10531054
RELEASE_NOTES_5.8.2-beta.7.md previous beta release notes
10541055
RELEASE_NOTES_5.8.2-beta.6.md previous beta release notes
10551056
RELEASE_NOTES_5.8.2-beta.5.md previous beta release notes
@@ -1076,7 +1077,7 @@ npm run lint
10761077
npm test
10771078
```
10781079

1079-
Current packaged version: `5.8.2-beta.8`
1080+
Current packaged version: `5.9.0`
10801081

10811082
## Release Readiness
10821083

@@ -1130,6 +1131,7 @@ Credit and thanks:
11301131

11311132
- [Local deployment guide](./LOCAL_DEPLOYMENT.md)
11321133
- [Publishing checklist](./PUBLISHING.md)
1134+
- [5.9.0 release notes](./RELEASE_NOTES_5.9.0.md)
11331135
- [5.8.2 Beta 8 release notes](./RELEASE_NOTES_5.8.2-beta.8.md)
11341136
- [5.8.2 Beta 7 release notes](./RELEASE_NOTES_5.8.2-beta.7.md)
11351137
- [5.8.2 Beta 6 release notes](./RELEASE_NOTES_5.8.2-beta.6.md)

RELEASE_NOTES_5.9.0.md

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
# HOMEii Music Flow 5.9.0
2+
3+
Release date: 2026-06-03
4+
5+
HOMEii Music Flow 5.9.0 is a major mobile, diagnostics, settings, and community release. It promotes the 5.8.2 beta stabilization work into a stable release, adds the new Library Wheel browsing experience, improves phone edge-to-edge behavior, expands Diagnostics v3, and incorporates several community PR ideas into the main card.
6+
7+
## Release Highlights
8+
9+
- **New Library Wheel experience:** the Queue Wheel-style vertical browser is now available across the library: playlists, artists, albums, tracks, liked items, radio stations, and artist albums.
10+
- **Artist album wheel as a full-screen page:** artist albums now open in a clean Queue Flow-style full page with its own close button. The caption shows the album title and release year.
11+
- **Radio wheel polish:** Radio uses one stable wheel stage instead of stacking multiple sections. The caption shows the station name.
12+
- **Diagnostics v3 is now a headline support tool:** diagnostics can be run from the in-card settings and the Home Assistant visual editor, with clearer checks for Music Assistant, queue/library providers, Direct API, Sendspin, browser context, artwork paths, and privacy-safe URLs.
13+
- **Phone edge-to-edge mode:** phones can use a true full-screen card experience while menus open as frontmost full-screen layers instead of overlapping controls.
14+
- **Reusable dashboard support:** `card_id` isolates per-card state, and query-string player overrides such as `?player=kitchen_sonos` make reusable dashboard includes much easier.
15+
- **Settings and performance work:** visual settings are organized into accordion sections, frequent toggles refresh without rebuilding the whole card, and artwork cache behavior adapts better to the selected performance profile.
16+
- **Danish localization:** Danish is now included, with follow-up placeholder fixes so translated runtime variables render correctly.
17+
18+
## New: Library Wheel
19+
20+
The Queue Wheel proved useful for fast queue navigation, so 5.9.0 extends the same interaction model into the music library.
21+
22+
Available wheel pages:
23+
24+
- Playlists
25+
- Artists
26+
- Albums
27+
- Tracks
28+
- Liked items
29+
- Radio stations
30+
- Artist albums
31+
32+
The goal is fast browsing on phones and touchscreens without turning library pages into cramped grids. The normal grid/list views remain available; the wheel is an additional browsing mode.
33+
34+
Artist albums and radio received extra polish after local testing:
35+
36+
- Artist album wheel opens as a dedicated full-screen page, not inside the artist detail section.
37+
- Artist album captions show album title and year.
38+
- Radio wheel renders one scroll stage only, avoiding long stacked pages.
39+
- Radio captions show the station name.
40+
41+
## Diagnostics v3
42+
43+
Diagnostics v3 is designed to reduce support loops and make Music Assistant setup issues easier to understand.
44+
45+
It reports:
46+
47+
- HOMEii runtime version and diagnostics version.
48+
- Browser, platform, viewport, DPR, touch support, and language.
49+
- Home Assistant URL details with privacy-safe redaction.
50+
- Music Assistant service availability.
51+
- Music Assistant config entry state.
52+
- Strict Music Assistant players and fallback media players.
53+
- Selected-player markers such as `app_id`, `mass_player_type`, `active_queue`, and registry platform.
54+
- Direct Music Assistant API and WebSocket state when configured.
55+
- Sendspin browser support and endpoint readiness.
56+
- Queue identity, queue providers, queue snapshot status, and queue artwork sample.
57+
- Library providers, library coverage, and library artwork sample.
58+
59+
External and private hostnames are redacted by default in visible and copied reports.
60+
61+
## Mobile And Layout
62+
63+
5.9.0 includes several phone-focused fixes and improvements:
64+
65+
- Edge-to-edge mode is part of the phone layout mode choice.
66+
- Compact-card expansion opens into a frontmost full-screen experience.
67+
- Full-screen menus no longer layer controls on top of each other.
68+
- The Actions screen behaves like a full-screen mobile page.
69+
- Player-selection controls were moved higher in the phone layout for better spacing.
70+
- The library toolbar keeps the wheel button compact so it does not overlap search, sort, player focus, or quick action buttons.
71+
- The Players screen action hub is clearer, with four icon-and-text actions: This device, Queue, Groups, and Clear all.
72+
73+
## Settings, State, And Reusable Dashboards
74+
75+
This release includes the community-driven `card_id` direction and reusable-dashboard work:
76+
77+
- Optional `card_id` YAML key scopes browser/local storage per card instance.
78+
- Multiple cards in the same browser can keep different selected players, pinned/excluded players, themes, layout choices, screensaver settings, and other in-card customizations.
79+
- Query-string player overrides are supported:
80+
81+
```text
82+
?player=kitchen_sonos
83+
?homeii_player=kitchen_sonos
84+
?homeii_player_<card_id>=kitchen_sonos
85+
```
86+
87+
This makes it easier to reuse the same dashboard/card definition across rooms and tablets.
88+
89+
Migration note:
90+
91+
Adding `card_id` to a card that previously had no `card_id` will appear to reset that card's in-card customizations once. The old global values remain in browser storage; the card simply starts reading from card-scoped keys.
92+
93+
## Music Assistant Compatibility
94+
95+
5.9.0 includes the full 5.8.2 beta stabilization series:
96+
97+
- Integration-first behavior so core card features can run through the Home Assistant Music Assistant integration.
98+
- Clearer handling when Direct API browser access is blocked by CORS or mixed-content rules.
99+
- Better fallback behavior when Music Assistant services exist but strict player markers are missing.
100+
- More useful queue and library diagnostics.
101+
- Correct `config_entry_id` handling for Home Assistant `music_assistant` service calls that require it.
102+
- Cleaner `music_assistant.get_queue` diagnostic calls.
103+
- Reduced retry noise for invalid direct Music Assistant URLs.
104+
- Queue snapshot protection so an initial partial or empty Home Assistant response does not replace a complete queue.
105+
106+
Issue #28 remains a special compatibility case for setups where the selected player is exposed as a generic Home Assistant player without Music Assistant queue identity. Diagnostics v3 now gives enough context to keep investigating without blocking the stable release.
107+
108+
## Fixes
109+
110+
- Fixes the beta 8 regression where starting a playlist could leave only one or two queue items visible.
111+
- Fixes mobile visual-editor diagnostics fallback when clipboard access is blocked by the HA Companion app or browser.
112+
- Fixes visual-editor diagnostic contrast in themes that made text too light.
113+
- Keeps visual-editor player settings focused on strict Music Assistant players instead of every generic `media_player`.
114+
- Fixes Danish interpolation placeholders such as `{player}`, `{title}`, `{count}`, and `{remaining}`.
115+
- Keeps Direct API failures non-fatal when the Home Assistant Music Assistant integration is available.
116+
- Improves radio and artist-album wheel scrolling so they behave like the Queue Wheel.
117+
118+
## Community Credits
119+
120+
Huge thanks to **@tocDK** for taking an active role in this release cycle.
121+
122+
His PRs and proposals helped shape:
123+
124+
- `card_id` / per-card state isolation.
125+
- Settings structure and refresh performance.
126+
- Artwork cache behavior by performance profile.
127+
- Danish localization.
128+
- Danish placeholder fixes.
129+
- Several practical performance and maintainability discussions.
130+
131+
Some PRs were not merged verbatim because this release needed to stabilize the current code path, but the ideas and fixes were incorporated into 5.9.0 with release credit.
132+
133+
Thank you also to everyone who opened issues, posted screenshots, ran beta builds, copied diagnostics reports, and helped find real-world mobile and Music Assistant edge cases. The 5.9.0 release is very much shaped by that feedback.
134+
135+
## Validation
136+
137+
Before release, the following checks passed:
138+
139+
- Full ESLint.
140+
- Full Vitest suite: 192 tests passed.
141+
- Vite production build.
142+
- Release artifact sync into `dist/`.
143+
144+
## Install / Cache Refresh
145+
146+
HACS users can update normally once the GitHub release is available.
147+
148+
Manual installs should replace the contents of:
149+
150+
```text
151+
/config/www/community/homeii-music-flow/
152+
```
153+
154+
Then refresh the Dashboard resource with:
155+
156+
```text
157+
/local/community/homeii-music-flow/homeii-music-flow.js?v=5.9.0
158+
```
159+
160+
After updating, hard refresh the Home Assistant dashboard or restart the HA Companion app if the old frontend bundle remains cached.

0 commit comments

Comments
 (0)