|
| 1 | +# HOMEii Music Flow Documentation |
| 2 | + |
| 3 | +HOMEii Music Flow is a premium Music Assistant dashboard card for Home Assistant. This documentation is the main place to learn how to install it, configure it, understand every major feature, and troubleshoot real-world Music Assistant setups. |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +## Quick Navigation |
| 8 | + |
| 9 | +- **Install the card:** [Getting Started](./getting-started.md) |
| 10 | +- **Configure Music Assistant, Sendspin, `card_id`, and URL player overrides:** [Configuration](./configuration.md) |
| 11 | +- **Learn what every screen does:** [Feature Guide](./features.md) |
| 12 | +- **Choose the right phone/tablet/dashboard mode:** [Layouts And Mobile Modes](./layouts.md) |
| 13 | +- **Generate a support report:** [Diagnostics](./diagnostics.md) |
| 14 | +- **Fix common problems:** [Troubleshooting](./troubleshooting.md) |
| 15 | + |
| 16 | +## Start Here |
| 17 | + |
| 18 | +If you are new to HOMEii Music Flow, use this path: |
| 19 | + |
| 20 | +1. [Getting Started](./getting-started.md) |
| 21 | +2. [Configuration](./configuration.md) |
| 22 | +3. [Feature Guide](./features.md) |
| 23 | +4. [Layouts And Mobile Modes](./layouts.md) |
| 24 | +5. [Diagnostics](./diagnostics.md) |
| 25 | +6. [Troubleshooting](./troubleshooting.md) |
| 26 | + |
| 27 | +## What You Need |
| 28 | + |
| 29 | +HOMEii Music Flow needs: |
| 30 | + |
| 31 | +- Home Assistant with dashboards/custom cards enabled. |
| 32 | +- Music Assistant installed and connected to Home Assistant. |
| 33 | +- At least one Music Assistant player exposed as a Home Assistant `media_player`. |
| 34 | +- HACS, or manual access to `/config/www/community/`. |
| 35 | +- A modern browser: Chrome, Edge, Safari, iOS WebKit, Android WebView, or a current Home Assistant Companion app. |
| 36 | + |
| 37 | +Optional features need optional setup: |
| 38 | + |
| 39 | +- **This device / Sendspin browser player:** direct Music Assistant URL and token. |
| 40 | +- **Announcements:** a working Home Assistant TTS entity. |
| 41 | +- **Automation helper:** an `input_text` helper for the active HOMEii player. |
| 42 | +- **Remote artwork and Direct API:** a browser-reachable Music Assistant URL, preferably HTTPS when Home Assistant is opened through HTTPS. |
| 43 | + |
| 44 | +## Documentation Map |
| 45 | + |
| 46 | +| Page | Use it for | |
| 47 | +| --- | --- | |
| 48 | +| [Getting Started](./getting-started.md) | HACS install, manual install, first card, first checks | |
| 49 | +| [Configuration](./configuration.md) | YAML options, visual editor, Music Assistant connection, Sendspin, `card_id`, query-string player overrides | |
| 50 | +| [Feature Guide](./features.md) | Main player, library, queue, Library Wheel, Queue Wheel, FLOW, Studio, lyrics, announcements, favorites, history | |
| 51 | +| [Layouts And Mobile Modes](./layouts.md) | Phone, tablet, desktop, compact, full, edge-to-edge, Section view, Panel view | |
| 52 | +| [Diagnostics](./diagnostics.md) | What Diagnostics v3 checks, how to copy a useful report, what each warning usually means | |
| 53 | +| [Troubleshooting](./troubleshooting.md) | Missing artwork, empty queue, no players, HTTPS/HTTP issues, Companion app quirks | |
| 54 | + |
| 55 | +## Recommended Dashboard Setup |
| 56 | + |
| 57 | +For the most polished experience: |
| 58 | + |
| 59 | +- Use a **Panel view** or a full-width **Section view** for the primary music dashboard. |
| 60 | +- On phones, use **Full** or **Edge to edge** mode if HOMEii Music Flow is the main screen. |
| 61 | +- Use **Compact** only when HOMEii Music Flow shares a dashboard with other cards. |
| 62 | +- If multiple HOMEii cards run in the same browser, give each one a unique `card_id`. |
| 63 | +- Keep Diagnostics available in the card settings. It is the fastest way to understand user reports. |
| 64 | + |
| 65 | +## Current Stable Version |
| 66 | + |
| 67 | +Current documentation target: **HOMEii Music Flow 5.9.0** |
| 68 | + |
| 69 | +5.9.0 documentation highlights: |
| 70 | + |
| 71 | +- [Reusable dashboards with `card_id`](./configuration.md#card_id) |
| 72 | +- [Open a dashboard directly to a player with URL parameters](./configuration.md#open-a-dashboard-directly-to-a-player) |
| 73 | +- [Library Wheel and Queue Wheel](./features.md#library-wheel) |
| 74 | +- [Phone edge-to-edge mode](./layouts.md#edge-to-edge) |
| 75 | +- [Diagnostics v3](./diagnostics.md) |
| 76 | + |
| 77 | +Release notes: |
| 78 | + |
| 79 | +- [HOMEii Music Flow 5.9.0](../RELEASE_NOTES_5.9.0.md) |
| 80 | +- [Changelog](../CHANGELOG.md) |
| 81 | + |
| 82 | +## Community And Credits |
| 83 | + |
| 84 | +HOMEii Music Flow is an independent community project. It is not an official Home Assistant or Music Assistant project. |
| 85 | + |
| 86 | +Thanks to the Music Assistant, Home Assistant, HACS, Sendspin, and Embla projects, and to all community testers and translators who helped shape the card. |
0 commit comments