Skip to content

Add CAST-1 wiki (WIP): intro + troubleshooting + Music Assistant getting started draft - #1046

Merged
bharvey88 merged 3 commits into
devfrom
feat/cast1-wiki
Jul 25, 2026
Merged

Add CAST-1 wiki (WIP): intro + troubleshooting + Music Assistant getting started draft#1046
bharvey88 merged 3 commits into
devfrom
feat/cast1-wiki

Conversation

@bharvey88

@bharvey88 bharvey88 commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

CAST-1 wiki (work in progress, do not merge yet)

Starts the CAST-1 product wiki. Opened as a draft for handoff/resume, not for merge.

Ready for review

  • Introduction - Music Assistant + Sendspin streaming, multi-room grouping, optional WizMote (feature leads bolded, WizMote links to the blueprint page)
  • Troubleshooting > Re-Flash - new install.apolloautomation.com/#/cast-1 installer, Variant WiFi/Ethernet, "USB JTAG/serial debug unit" + Allow, inlined boot Method 2, annotated boot/reset button photo
  • Troubleshooting > Boot Mode - Method 1 (boot only) + Method 2 (boot + reset); boot = left, reset = right
  • Troubleshooting > Reset Wi-Fi Credentials - WiFi-firmware-only note, reflash fallback tip

Still in progress (do not publish)

  • Getting Started - drafted (physical 3.5mm + onboarding + Music Assistant), but onboarding GUI steps are unverified and the Music Assistant player name is unconfirmed (Sendspin Player vs Player). Needs a walkthrough before publishing.
  • Not yet built: Additional Info (General Tips, Sensor Definitions, Bluetooth Proxy), WizMote blueprint page (pull blueprint from Blueprints beta), FAQ, Teardown (needs mechanical photos)

Notes for resume

  • Only placeholder asset still missing: cast-1-plug-in-usb-c.webp
  • Workspace clone: C:\tmp\cast1-docs-session (branch feat/cast1-wiki)
  • Open TODO from Brandon: strip "Chromium based browser" wording from the other product pages too

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added comprehensive CAST-1 documentation covering introduction, setup, Home Assistant integration, audio streaming, sensor definitions, and troubleshooting.
    • Added guidance for ESPHome Device Builder installation, boot mode, firmware reflashing, and Wi‑Fi credential resets.
    • Added CAST-1 content to the documentation navigation.
    • Updated ESPHome Device Builder download links for Windows, macOS, and Linux.
    • Updated CAST-1 boot/reset instructions with refreshed imagery.

…started draft

Start the CAST-1 product wiki:

- Introduction: Music Assistant + Sendspin streaming, multi-room grouping,
  optional WizMote control (bolded feature leads, WizMote links to blueprint)
- Troubleshooting > Re-Flash: new install.apolloautomation.com/#/cast-1
  installer, Variant WiFi/Ethernet, "USB JTAG/serial debug unit" + Allow,
  inlined boot Method 2, annotated boot/reset button photo
- Troubleshooting > Boot Mode: Method 1 (boot button only) and Method 2
  (boot + reset), boot = left / reset = right
- Troubleshooting > Reset Wi-Fi Credentials: WiFi-firmware-only note,
  reflash fallback tip
- Getting Started draft (physical 3.5mm line-out + onboarding + Music
  Assistant install/player/multi-room). Still needs the GUI walkthrough and
  the Music Assistant player-name confirmation before publishing.
- Assets: annotated cast-1-boot-reset-buttons.webp, boot-mode Method 1/2
  gifs, cast-1-reflash-firmware.gif

Not for merge yet: opened for handoff/resume. Getting Started and the
remaining pages (Additional Info, WizMote blueprint, FAQ, Teardown) are
still in progress.

🤖 Generated with [Claude Code](https://claude.com/claude-code)
@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 0a3ab536-575d-4f98-b8c4-96e5f6b4ecb2

📥 Commits

Reviewing files that changed from the base of the PR and between c91f475 and f00bf39.

⛔ Files ignored due to path filters (6)
  • docs/assets/cast-1-add-via-improv-ble.gif is excluded by !**/*.gif
  • docs/assets/cast-1-esphome-device-builder-install.gif is excluded by !**/*.gif
  • docs/assets/cast-1-esphome-device-builder.gif is excluded by !**/*.gif
  • docs/assets/cast-1-home-assistant-integration.gif is excluded by !**/*.gif
  • docs/assets/cast-1-reflash-firmware.gif is excluded by !**/*.gif
  • docs/assets/cast-1-start-music-assistant.gif is excluded by !**/*.gif
📒 Files selected for processing (14)
  • docs/assets/cast-1-boot-mode-method-1.webp
  • docs/assets/cast-1-boot-mode-method-2.webp
  • docs/assets/cast-1-boot-reset-buttons.webp
  • docs/assets/cast-1-connect-to-hotspot.webp
  • docs/assets/cast-1-physical-setup.webp
  • docs/products/ESPHome-Starter-Kit/setup/first-steps.md
  • docs/products/cast1/additional-info/esphome-device-builder.md
  • docs/products/cast1/introduction.md
  • docs/products/cast1/setup/getting-started.md
  • docs/products/cast1/setup/sensor-definitions.md
  • docs/products/cast1/troubleshooting/cast1-boot-mode.md
  • docs/products/cast1/troubleshooting/cast1-reflash.md
  • docs/products/cast1/troubleshooting/cast1-reset-wi-fi-credentials.md
  • mkdocs.yml
🔥 Files not summarized due to errors (4)
  • docs/assets/cast-1-connect-to-hotspot.webp: Server error: no LLM provider could handle the message
  • docs/assets/cast-1-physical-setup.webp: Server error: no LLM provider could handle the message
  • docs/assets/cast-1-boot-mode-method-2.webp: Server error: no LLM provider could handle the message
  • docs/assets/cast-1-boot-mode-method-1.webp: Server error: no LLM provider could handle the message

Walkthrough

Added a complete CAST-1 documentation section covering product features, setup, Home Assistant and Music Assistant integration, ESPHome Device Builder usage, entity definitions, troubleshooting, reflashing, Wi-Fi resets, navigation, and related instructional media.

Changes

CAST-1 Documentation

Layer / File(s) Summary
CAST-1 overview and navigation
docs/products/cast1/introduction.md, mkdocs.yml
Adds the CAST-1 introduction page and navigation entries for setup, additional information, and troubleshooting.
CAST-1 setup and playback flow
docs/products/cast1/setup/getting-started.md
Documents physical connections, Wi-Fi provisioning, Home Assistant integration, Music Assistant playback, multi-room grouping, and WizMote setup.
ESPHome Device Builder workflow
docs/products/cast1/additional-info/esphome-device-builder.md, docs/products/ESPHome-Starter-Kit/setup/first-steps.md
Adds CAST-1 Device Builder instructions and updates Starter Kit download links for Windows, macOS, and Linux.
Entity reference and troubleshooting
docs/products/cast1/setup/sensor-definitions.md, docs/products/cast1/troubleshooting/*, docs/assets/cast-1-boot-reset-buttons.webp
Adds CAST-1 entity definitions and guides for boot mode, reflashing, and Wi-Fi credential resets, with updated boot/reset media.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

Poem

A bunny hops through CAST-1 lore,
With Wi-Fi paths and buttons galore.
Music syncs from room to room,
Fresh guides help the speakers bloom.
Reflash, reset—then thump the floor!

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/cast1-wiki

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

…ted onboarding

- Sensor Definitions: full entity list including WizMote button selects, WizMote
  Status, and Link Speed
- ESPHome Device Builder (Additional Info): platform install tabs reused from ESK
  (Windows/Mac/Linux/Home Assistant App), Take Control + Install flow with My
  Home Assistant buttons and gifs
- Getting Started: Physical Setup and Music Assistant folded in; Wi-Fi methods
  (Hotspot / Improv BLE) presented as content tabs; My Home Assistant badge
  buttons for the integrations page, add-on store, and the Music Assistant
  add-on; real gifs swapped in for the onboarding steps
- Temporary: esphome.io/install -> desktop.esphome.io on the CAST-1 and ESK
  pages (revert once the switchover happens)

🤖 Generated with [Claude Code](https://claude.com/claude-code)
… publish

- Remove intro hero, select-player, and multi-room image references until the
  gifs are ready
- Soften the Music Assistant player-name wording pending confirmation
- Unlink "Pair a Wiz WizMote" in the intro until the blueprint page exists

🤖 Generated with [Claude Code](https://claude.com/claude-code)
@bharvey88
bharvey88 marked this pull request as ready for review July 25, 2026 00:51
@bharvey88
bharvey88 merged commit 23026ae into dev Jul 25, 2026
1 check passed
@bharvey88
bharvey88 deleted the feat/cast1-wiki branch July 25, 2026 00:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant