Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,10 @@ Read the full style guide, but these are the ones worth checking twice:

- Product IDs are uppercase with a hyphen: **AIR-1**, **MTR-1**, never
`Air-1` or `air1`.
- **R PRO-1** is the exception: a space after the R, not a hyphen, in
all display text. Keep `rpro1`, `r-pro-1`, and `R_PRO-1` only in file
names, URLs, hostnames, and literal device names.
- **R PRO-1** and **CAST PRO-1** are the exceptions: a space before
PRO, not a hyphen, in all display text. Never `CAST-1 PRO`. Keep
`rpro1`, `r-pro-1`, `R_PRO-1`, `castpro1`, and `cast-pro-1` only in
file names, URLs, hostnames, entity IDs, and literal device names.
- **US English** spelling: color, center, meter, behavior.
- Flag must-know info with admonitions (`note` for prerequisites,
`tip`, `warning`, `success` for a "Next step" box with a primary
Expand Down
12 changes: 11 additions & 1 deletion STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Product IDs are always uppercase with a hyphen: **AIR-1**, **MTR-1**,
Never `Air-1`, `air1`, or `AIR1` in body copy. mkdocs.yml is the source
of truth for the canonical form.

**R PRO-1** is the one exception: its name has a space after the R, not
**R PRO-1** is an exception: its name has a space after the R, not
a hyphen. Write **R PRO-1** in titles, headings, nav labels, and body
copy, never `R-PRO-1`. The hyphenated and underscored forms survive
only where a space isn't allowed or where you quote the device
Expand All @@ -117,6 +117,16 @@ literally, and those must not be changed:
- The device name Home Assistant and Homey show: **Apollo R_PRO-1**
- The setup hotspot: **Apollo R PRO 1 Hotspot**

**CAST PRO-1** follows the same pattern: a space after CAST, then
**PRO-1**. Never `CAST-1 PRO`, `CAST-PRO-1`, or `Cast Pro`. It's a
different product from the **CAST-1**, so don't shorten it to CAST-1.
The same literal forms keep their own spelling:

- File and folder names and URLs: `castpro1/`, `cast-pro-1-intro-image.webp`
- Entity IDs: `media_player.apollo_cast_pro_1_xxxxxx_player`
- The device name Home Assistant and Music Assistant show: **Apollo CAST_PRO-1**
- The setup hotspot: **Apollo CAST_PRO-1 Hotspot**

### First mention per page

On the first mention of a product in body copy, use the full brand name:
Expand Down
Binary file added docs/assets/cast-pro-1-connect-to-hotspot.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/cast-pro-1-hero.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/cast-pro-1-plug-in-audio-in.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/cast-pro-1-plug-in-audio-out.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/cast-pro-1-ports.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/cast-pro-1-press-boot-button.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/cast-pro-1-remove-cover.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/cast-pro-1-remove-pcb.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/cast-pro-1-replace-cover.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/cast-pro-1-replace-pcb.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 48 additions & 0 deletions docs/products/castpro1/additional-info/analog-in.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: Play a source through CAST PRO-1 Analog In
description: Connect a turntable, TV, or other audio source to the CAST PRO-1 Analog In jack and play it through Music Assistant as a Sendspin Source.
---
# Play a source through Analog In

The **Analog In** jack on your CAST PRO-1 turns any line-level source into something Music Assistant can play. Plug in a turntable, TV, or CD player, and it shows up in Music Assistant as a **Sendspin Source**. Play it on the speakers connected to your CAST PRO-1, or on any other Music Assistant player in your home.

!!! note "Before you start"

Finish the [Getting Started guide](../setup/getting-started.md) first, so your CAST PRO-1 is in Home Assistant and Music Assistant is running.

## What you'll need

- **A line-level source.** Most TVs, CD players, and streamers output line level. A turntable needs a phono preamp between it and the CAST PRO-1, unless the turntable has one built in. If the turntable has a **PHONO / LINE** switch on the back, set it to **LINE**.
- **A cable with a 3.5mm plug** for the CAST PRO-1 end. For a source with RCA outputs, use an RCA-to-3.5mm cable.

## Connect your source

1\. Plug the source into the **Analog In** jack, the left of the two 3.5mm jacks. The **Analog/Optical Out** jack is output only, so a source plugged in there won't play.

![Plugging a USB-C power cable into the CAST PRO-1, then a 3.5mm cable into the Analog In jack](/assets/cast-pro-1-plug-in-audio-in.webp)

## Play it in Music Assistant

1\. Open **Music Assistant** from the Home Assistant sidebar and select **Browse**.

2\. Select **Sendspin Source (Apollo CAST_PRO-1 xxxxxx)**, where `xxxxxx` matches the end of your device's name. (1)
{ .annotate }

1. Your device's name is at the top of its device page in Home Assistant, for example **Apollo CAST_PRO-1 04c6d0**.

3\. Pick the player to hear it on. Choose your CAST PRO-1 to play the source through its own speakers, or any other player to hear it in another room.

<!-- TODO image: /assets/cast-pro-1-sendspin-source.webp | alt: Music Assistant Browse page showing the Sendspin Source for the CAST PRO-1 -->

## Choose the streaming quality

The **Line In Streaming** setting on your CAST PRO-1's device page sets how it sends your source over the network:

| Option | When to use it |
| --- | --- |
| **Compressed** | The default. Best for a weaker Wi-Fi connection, since it uses less bandwidth. |
| **Lossless** | Full quality. Pick it when your CAST PRO-1 is on Ethernet or a strong Wi-Fi signal. |

[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome)

[Join our Discord if you need more help! :simple-discord:](https://link.apolloautomation.com/discord){ .md-button }
143 changes: 143 additions & 0 deletions docs/products/castpro1/additional-info/esphome-device-builder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
---
title: ESPHome Device Builder
description: Optional. Use ESPHome Device Builder to rename your CAST PRO-1 or edit its YAML.
---
# ESPHome Device Builder

!!! tip "Most people don't need this"

Your CAST PRO-1 ships ready to use. You only need the ESPHome Device Builder if you want to rename it or make manual edits to its YAML. To add your CAST PRO-1 to Home Assistant, follow the [Getting Started guide](https://wiki.apolloautomation.com/products/castpro1/setup/getting-started/#add-to-home-assistant).

ESPHome Device Builder is the software that gives you a user interface for editing, compiling, and flashing ESPHome YAML. You'll use it to take control of your CAST PRO-1 and edit its configuration.

## Install ESPHome Device Builder

Pick the platform you'll be running ESPHome Device Builder on:

=== "Windows"

1. Open <a href="https://esphome.io/install/" target="_blank" rel="noreferrer nofollow noopener">esphome.io/install</a> and click **Download installer (.exe)** on the **Windows** tab.
2. Open the downloaded `.exe` file. If Windows asks whether to allow the app to make changes, choose **Yes**, then follow the installer prompts.
3. On the last screen, leave **Run ESPHome Device Builder** checked and click **Finish**.
4. When **Allow network pairing** appears, click **Allow access**. Windows then asks for administrator approval and shows its own firewall prompt for the Python backend. Allow that one too, or other ESPHome dashboards on your network won't be able to reach this computer.

!!! warning "If Windows blocks the installer"

If a blue **Windows protected your PC** warning appears when you open the `.exe`, click **More info → Run anyway** to continue.

![Downloading the ESPHome Device Builder Windows installer, choosing Run anyway, and running setup](/assets/esphome-builder-install-windows.gif)

The first launch takes a moment while it sets itself up, then the dashboard opens in your browser at <a href="http://localhost:6052/" target="_blank" rel="noreferrer nofollow noopener">http://localhost:6052/</a>. An ESPHome icon lands in your notification area for getting back to it later.

A short wizard runs the first time:

1. Click **Continue** on the welcome screen.
2. Choose **Installation of the ESPHome Device Builder**, since you're building on this computer.
3. Choose **New to ESPHome** for the simpler, guided interface.

Then take **Start guided tour** for a five minute walkthrough, or **Maybe later**.

![ESPHome Device Builder first-run wizard, choosing local installation and New to ESPHome](/assets/device-builder-first-time-install-pick-your-experience.gif)

=== "Mac"

1. Open <a href="https://esphome.io/install/" target="_blank" rel="noreferrer nofollow noopener">esphome.io/install</a>. The page detects your OS and opens the **macOS** tab. Pick the build that matches your chip:

- **Apple Silicon** (M1, M2, M3, M4, M5)
- **Intel**

Not sure which you have? Click the Apple menu → **About This Mac**.

2. Open the `.dmg` and drag **ESPHome Device Builder** into your Applications folder.

3. Open your Applications folder and double-click **ESPHome Device Builder**. The first time you run it, macOS may ask you to confirm. Click **Open**.

- If macOS blocks it outright with a Gatekeeper warning instead, right-click the app in Applications and choose **Open**, then click **Open** in the confirmation dialog. After that, double-click works normally.

The first launch takes a moment while it sets itself up, then the dashboard opens in your browser at <a href="http://localhost:6052/" target="_blank" rel="noreferrer nofollow noopener">http://localhost:6052/</a>. An ESPHome icon lands in your menu bar for getting back to it later.

A short wizard runs the first time:

1. Click **Continue** on the welcome screen.
2. Choose **Installation of the ESPHome Device Builder**, since you're building on this computer.
3. Choose **New to ESPHome** for the simpler, guided interface.

Then take **Start guided tour** for a five minute walkthrough, or **Maybe later**.

![ESPHome Device Builder first-run wizard, choosing local installation and New to ESPHome](/assets/device-builder-first-time-install-pick-your-experience.gif)

=== "Home Assistant App"

The ESPHome Device Builder runs as a Home Assistant app served right inside your existing HA dashboard. This is the easiest option if you already run Home Assistant OS or a supervised install.

**<u>Method 1</u>**

To add the **ESPHome Device Builder** to your Home Assistant instance, use this My button:

[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon)

**<u>Method 2</u>**

You can also install it yourself from the Home Assistant App Store.

1. In Home Assistant, open **Settings → Apps → App Store**.
2. Search for **ESPHome Device Builder** and click **Install**.
3. Once installed, click **Start**, then **Open Web UI**. The Device Builder will open inside your Home Assistant dashboard.

=== "Linux"

1. Open <a href="https://esphome.io/install/" target="_blank" rel="noreferrer nofollow noopener">esphome.io/install</a>. The page opens on the **Linux** tab with **Debian / Ubuntu** selected. Choose the package format your distro uses, then the CPU architecture (**x86_64** for a normal desktop or laptop, **arm64** for a Raspberry Pi or similar board):

- **Debian / Ubuntu** → downloads a `.deb`
- **Fedora / openSUSE** → downloads a `.rpm`
- **Arch (AUR)** → installs the `esphome-desktop-bin` package
- **AppImage** → a portable build that runs on any distro

2. Install it. Double-click the downloaded `.deb` or `.rpm` in your file manager, or run the matching command in a terminal:

- **Debian / Ubuntu:** `sudo apt install ./ESPHome.Device.Builder_*.deb`
- **Fedora / openSUSE:** `sudo dnf install ./ESPHome.Device.Builder-*.rpm`
- **Arch:** `yay -S esphome-desktop-bin`
- **AppImage:** `chmod +x ESPHome.Device.Builder_*.AppImage` then run `./ESPHome.Device.Builder_*.AppImage`

3. Launch **ESPHome Device Builder** from your applications menu.

If your CAST PRO-1 doesn't appear as a serial port later, add your user to the `dialout` group with `sudo usermod -a -G dialout $USER`, then log out and back in.

The first launch takes a moment while it sets itself up, then the dashboard opens in your browser at <a href="http://localhost:6052/" target="_blank" rel="noreferrer nofollow noopener">http://localhost:6052/</a>. An ESPHome icon lands in your system tray for getting back to it later. Some Linux desktops, notably GNOME without a tray extension, don't show tray icons at all. The app still runs, so use the dashboard in your browser.

A short wizard runs the first time:

1. Click **Continue** on the welcome screen.
2. Choose **Installation of the ESPHome Device Builder**, since you're building on this computer.
3. Choose **New to ESPHome** for the simpler, guided interface.

Then take **Start guided tour** for a five minute walkthrough, or **Maybe later**.

![ESPHome Device Builder first-run wizard, choosing local installation and New to ESPHome](/assets/device-builder-first-time-install-pick-your-experience.gif)

## Take control of your CAST PRO-1

Taking control adopts your device into the ESPHome Device Builder so you can rename it or edit its YAML.

1\. Open the ESPHome Device Builder.

[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon)

2\. Click **Show** next to **Discovered** at the top, then click **Take Control** next to your CAST PRO-1. Change the **Name** and **Friendly Name** if you'd like, or leave them, then click **Take Control** again.

<!-- TODO image: /assets/cast-pro-1-esphome-device-builder.gif | alt: Clicking Show, then Take control on the discovered CAST PRO-1 in ESPHome Device Builder -->

3\. Click **Install** (the up arrow icon), then click **On the network** and watch it finish installing. (1)
{ .annotate }

1. This takes 5 to 10 minutes depending on how fast your device is.

<!-- TODO image: /assets/cast-pro-1-esphome-device-builder-install.gif | alt: Clicking Install on the CAST PRO-1, choosing On the network, and watching the build log -->

4\. Once it completes, click **Stop**, then press the **reset** button (on the left) on your device. Your CAST PRO-1 will reboot and it's now ready to test out!

!!! success "You're all set!"

Your CAST PRO-1 is now adopted into the ESPHome Device Builder, where you can rename it or edit its YAML.

Loading
Loading