Skip to content

Add CAST-1 Ethernet, FAQ, and TTS documentation - #1062

Merged
bharvey88 merged 1 commit into
devfrom
feat/cast1-ethernet
Jul 31, 2026
Merged

Add CAST-1 Ethernet, FAQ, and TTS documentation#1062
bharvey88 merged 1 commit into
devfrom
feat/cast1-ethernet

Conversation

@bharvey88

@bharvey88 bharvey88 commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Ethernet had no coverage on the CAST-1 wiki at all. The Ethernet firmware drops wifi, captive_portal, improv_serial and esp32_improv entirely, so neither onboarding path on Getting Started worked for an Ethernet unit.

New pages

  • Adding the Ethernet Module covers the physical install of the header board, with a gif.
  • Switch Firmware covers moving between the Wi-Fi and Ethernet builds, both from Home Assistant and over USB with the installer.
  • FAQ, 15 questions, including the two-media-player confusion and the fact that the CAST-1 isn't a Bluetooth speaker.
  • TTS and Announcements covers the announcement pipeline, the 40 dB ducking, and the LED behavior during announcements.

Changes to existing pages

  • Getting Started gains an Ethernet tab. The section is renamed from "Connect to Wi-Fi" to Connect to Your Network since it now covers three paths. The Improv "already added" note moved into the Improv tab where it belongs, and two Music Assistant gifs were added.
  • Sensor Definitions drops the Link Speed row. No CAST-1 branch exposes a link speed sensor, and the Ethernet firmware's ethernet_info block only provides ip_address. It also gains links to Switch Firmware, the general Updating Firmware guide, and the new TTS page.
  • WizMote Control now shows how to reach the device page, gains pairing and blueprint gifs, and notes that pairing takes longer on the Ethernet firmware, where ESP-NOW scans channels 1 to 13 with a 30 second dwell.
  • Introduction gains a hero image.

Notes

The Factory Reset ESP entity name in Sensor Definitions matches ApolloAutomation/CAST-1#62, which is on beta and not yet released to stable.

ApolloAutomation/CAST-1#63 renames the two media player entities to Player and Sendspin Player. That is also on beta only, so the pages here still use the current stable names and will need a follow-up when that firmware releases.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added comprehensive CAST-1 setup guidance, including hotspot, BLE, Ethernet installation, firmware switching, and troubleshooting.
    • Added documentation for text-to-speech, announcements, WizMote pairing, Ethernet modules, and frequently asked questions.
    • Expanded sensor and firmware setting descriptions, with updated entity names and relevant links.
    • Added instructional images and animations for setup, music playback, and multi-room playback.
    • Updated navigation to make new CAST-1 guides easier to find.

Ethernet had no coverage at all, even though the Ethernet firmware has
no Wi-Fi, so neither onboarding path on Getting Started worked for it.

New pages:
- Adding the Ethernet Module, covering the physical install
- Switch Firmware, moving between the Wi-Fi and Ethernet builds
- FAQ, 15 questions
- TTS and Announcements, covering the announcement pipeline and ducking

Getting Started gains an Ethernet tab, and the section is renamed to
Connect to Your Network to cover all three paths. Sensor Definitions
drops the Link Speed row, which no firmware branch exposes, and gains
links to Switch Firmware, Updating Firmware, and the new TTS page.
WizMote Control now shows how to reach the device page and notes that
pairing takes longer on the Ethernet firmware.

🤖 Generated with [Claude Code](https://claude.com/claude-code)
@bharvey88
bharvey88 merged commit b0c0bde into dev Jul 31, 2026
@bharvey88
bharvey88 deleted the feat/cast1-ethernet branch July 31, 2026 23:44
@coderabbitai

coderabbitai Bot commented Jul 31, 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: b9110724-1155-4581-ad7e-a8227f4eb757

📥 Commits

Reviewing files that changed from the base of the PR and between 4e630d4 and c7be2fb.

⛔ Files ignored due to path filters (4)
  • docs/assets/cast-1-import-blueprint.gif is excluded by !**/*.gif
  • docs/assets/cast-1-pair-wizmote.gif is excluded by !**/*.gif
  • docs/assets/cast-1-play-in-multiple-rooms.gif is excluded by !**/*.gif
  • docs/assets/cast-1-play-song.gif is excluded by !**/*.gif
📒 Files selected for processing (11)
  • docs/assets/cast-1-connect-ethernet-module.webp
  • docs/assets/cast-1-intro-image.webp
  • docs/products/cast1/addons/ethernet-module.md
  • docs/products/cast1/examples/tts-announcements.md
  • docs/products/cast1/examples/wizmote-blueprint.md
  • docs/products/cast1/faq.md
  • docs/products/cast1/introduction.md
  • docs/products/cast1/setup/cast1-switch-firmware.md
  • docs/products/cast1/setup/getting-started.md
  • docs/products/cast1/setup/sensor-definitions.md
  • mkdocs.yml
🔥 Files not summarized due to errors (1)
  • docs/assets/cast-1-connect-ethernet-module.webp: Server error: no LLM provider could handle the message

Walkthrough

Expanded CAST-1 documentation with Ethernet setup, firmware switching, TTS and announcements, WizMote pairing, FAQs, visual assets, and updated navigation.

Changes

CAST-1 documentation

Layer / File(s) Summary
Network setup and firmware guidance
docs/products/cast1/addons/ethernet-module.md, docs/products/cast1/setup/cast1-switch-firmware.md, docs/products/cast1/setup/getting-started.md, docs/products/cast1/setup/sensor-definitions.md
Added Ethernet installation and setup instructions. Added Wi-Fi and Ethernet firmware-switching guides. Updated related sensor links and names.
Playback and control documentation
docs/products/cast1/examples/tts-announcements.md, docs/products/cast1/examples/wizmote-blueprint.md, docs/products/cast1/faq.md, docs/products/cast1/setup/getting-started.md
Added TTS, announcement, WizMote, compatibility, playback, and multi-room documentation.
Documentation assets and navigation
docs/assets/cast-1-intro-image.webp, docs/products/cast1/introduction.md, mkdocs.yml
Added the CAST-1 introduction image and new navigation entries for the documentation pages.

Estimated code review effort: 2 (Simple) | ~15 minutes

Possibly related PRs

Poem

A rabbit reads the CAST-1 guide,
Ethernet steps are now supplied.
TTS and WizMote hop in line,
New pages make the path more fine.
Fresh images glow with cheer—
“Documentation grows clearer here!”

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

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.

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