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
11 changes: 7 additions & 4 deletions docs/products/cast1/addons/ethernet-module.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Add the Ethernet Module to CAST-1
description: How to install the Ethernet add-on module on your CAST-1 and move it onto the Ethernet firmware.
description: "How to install the Ethernet add-on module on your CAST-1."
---
# Adding the Ethernet Module

The Ethernet add-on gives your CAST-1 a wired network connection in place of Wi-Fi. It's a small header board that presses onto the top of the CAST-1, so there's no case to open and nothing to solder.
The Ethernet add-on gives your CAST-1 a wired network connection. It's a small header board that presses onto the top of the CAST-1, so there's no case to open and nothing to solder.

1\. Unplug your CAST-1 from power.

Expand All @@ -19,6 +19,9 @@ The Ethernet add-on gives your CAST-1 a wired network connection in place of Wi-

4\. Plug an Ethernet cable into the module, then plug the CAST-1 back into power.

Your CAST-1 is still running Wi-Fi firmware, so the wired connection won't come up yet. Switch it over using the guide below.
That's it. Your CAST-1 picks the wired connection up on its own. Check the **Network Connection** sensor on the device page to confirm it reads **Ethernet**. (1)
{ .annotate }

1. It reads **Ethernet + WiFi** if your CAST-1 is on both at once, which is what you want. Home Assistant keeps talking to the device that way while you plug or unplug the cable.

[Switch your CAST-1 to Ethernet firmware :material-lan-connect:](https://wiki.apolloautomation.com/products/cast1/setup/cast1-switch-firmware/){ .md-button .md-button--primary }
[Join our Discord if you need more help! :simple-discord:](https://link.apolloautomation.com/discord){ .md-button }
4 changes: 2 additions & 2 deletions docs/products/cast1/examples/wizmote-blueprint.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ Before the blueprint can control anything, pair your WizMote with the CAST-1.

![](/assets/cast-1-pair-wizmote.gif)

!!! note "Pairing works a little differently on the Ethernet firmware"
!!! note "Pairing takes longer on a CAST-1 running Ethernet only"

With no Wi-Fi to follow, your CAST-1 hops through radio channels 1 through 13 hunting for the WizMote, moving on every couple of seconds until it hears one. Keep pressing a button and it should pair within a minute.
A CAST-1 that's on Ethernet and not joined to any Wi-Fi network has no channel to follow, so it hops through radio channels 1 through 13 hunting for the WizMote, moving on every couple of seconds until it hears one. Keep pressing a button and it should pair within a minute.

### Import the Blueprint

Expand Down
5 changes: 4 additions & 1 deletion docs/products/cast1/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,10 @@ description: Frequently asked questions about the CAST-1 audio caster.

12\. **Can I connect it with an Ethernet cable instead of Wi-Fi?**

* Yes, with the [Ethernet add-on module](https://wiki.apolloautomation.com/products/cast1/addons/ethernet-module/). It's a header board that presses onto the top of the case, and your CAST-1 then runs the Ethernet firmware.
* Yes, with the [Ethernet add-on module](https://wiki.apolloautomation.com/products/cast1/addons/ethernet-module/). It's a header board that presses onto the top of the case. There's nothing to flash, one firmware covers both connections.
* Plug a cable in and your CAST-1 switches over to the wired connection. If it's also joined to your Wi-Fi it keeps both up at once, so Home Assistant doesn't lose the device while you plug or unplug the cable. Take the cable out and it goes back to Wi-Fi on its own.
* The **Network Connection** sensor on the device page shows which one is in use. It reads **Ethernet**, **WiFi**, **Ethernet + WiFi**, or **Hotspot**.
* The setup hotspot never broadcasts while an Ethernet cable is connected. Unplug the cable if you need it back.

13\. **Can I pair my phone to the CAST-1 over Bluetooth?**

Expand Down
51 changes: 0 additions & 51 deletions docs/products/cast1/setup/cast1-switch-firmware.md

This file was deleted.

13 changes: 6 additions & 7 deletions docs/products/cast1/setup/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,19 +61,18 @@ There are three ways to get your CAST-1 online. Pick whichever is easier, you on

=== "Ethernet"

Wired setup needs the <a href="https://wiki.apolloautomation.com/products/cast1/addons/ethernet-module/" target="_blank" rel="noopener">Ethernet module</a> fitted and your CAST-1 running the Ethernet firmware.

With the CAST-1 unplugged, line the module's pins up with the two rows of female header pins on top of the case, pin side down, and press it straight down until it sits flat.
With the CAST-1 unplugged, line the <a href="https://wiki.apolloautomation.com/products/cast1/addons/ethernet-module/" target="_blank" rel="noopener">Ethernet module</a> up with the two rows of female header pins on top of the case, pin side down, and press it straight down until it sits flat.

![](/assets/cast-1-connect-ethernet-module.webp)

1\. Every CAST-1 ships on Wi-Fi firmware, so flash yours over to Ethernet first. Follow the <a href="https://wiki.apolloautomation.com/products/cast1/troubleshooting/cast1-reflash/" target="_blank" rel="noopener">reflashing guide</a> and select **Ethernet** under **Variant**.
1\. Plug an Ethernet cable into the module, then plug the CAST-1 into power.

2\. Plug an Ethernet cable into the module, then plug the CAST-1 into power.
2\. Your CAST-1 picks up an address from your router on its own, so there's nothing to enter. (1)
{ .annotate }

3\. Your CAST-1 picks up an address from your router on its own, so there's nothing to enter.
1. Unplug the cable later and your CAST-1 falls back to Wi-Fi on its own. The [FAQ](https://wiki.apolloautomation.com/products/cast1/faq/) covers how the two connections work together.

4\. Home Assistant discovers your CAST-1 automatically. Add it below, then check the **IP Address** sensor on the device page to confirm the wired connection came up.
3\. Home Assistant discovers your CAST-1 automatically. Add it below, then check the **Network Connection** sensor on the device page to confirm it reads **Ethernet**.

### Add to Home Assistant

Expand Down
7 changes: 4 additions & 3 deletions docs/products/cast1/setup/sensor-definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ Once added to Home Assistant you can configure different settings for your CAST-
| Setting | Default | What it does |
|---------|:-------:|--------------|
| **Firmware Channel** | Stable | Which firmware channel the CAST-1 updates from. **Beta** gets new features earlier but is less tested than **Stable**. |
| **Firmware Type** | WiFi | Which firmware variant the CAST-1 updates to, **WiFi** or **Ethernet**. Match this to how your CAST-1 is connected. See [Switch Firmware](https://wiki.apolloautomation.com/products/cast1/setup/cast1-switch-firmware/) to move between the two. |
| **Firmware Update** | n/a | Checks for and installs a firmware update for the selected Firmware Type and Channel, straight from Home Assistant. See [Updating Firmware](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/updating-firmware/) for the full walkthrough. |
| **Firmware Update** | n/a | Checks for and installs a firmware update from the selected channel, straight from Home Assistant. See [Updating Firmware](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/updating-firmware/) for the full walkthrough. |
| **Bluetooth Proxy** | Off | Lets the CAST-1 act as a Bluetooth proxy for Home Assistant, extending Bluetooth range to nearby devices. |
| **WizMote Auto-Discovery** | Off | Turn on to pair a WizMote. While it's on, the next WizMote button press links that remote to your CAST-1. |
| **Clear WizMote Pairing** | n/a | Unpairs the current WizMote so you can pair a different one. |
Expand All @@ -52,7 +51,9 @@ Once added to Home Assistant you can configure different settings for your CAST-
| **WizMote Status** | Whether a WizMote is paired. Shows "No WizMote paired", "Discovery mode active", or "Paired:" with the remote's MAC address. |
| **Apollo Firmware Version** | The Apollo firmware build installed on the device (for example, `26.7.12.1`). |
| **ESPHome Version** | The ESPHome version the firmware was compiled with. |
| **IP Address** | The device's IP address on your network. |
| **Network Connection** | Which connection the CAST-1 is using: **Ethernet**, **WiFi**, **Ethernet + WiFi** when it's on both at once, **Hotspot** while it's waiting for Wi-Fi details, or **Connecting**. |
| **Ethernet IP Address** | The device's IP address on the wired connection. Needs the [Ethernet module](https://wiki.apolloautomation.com/products/cast1/addons/ethernet-module/) fitted. |
| **WiFi IP Address** | The device's IP address on your Wi-Fi network. |
| **Online** | Connection status of the device to Home Assistant. |
| **ESP Temperature** | Internal temperature of the ESP32 chip. Runs warmer than the room because of the processor and Wi-Fi radio. Disabled by default. |
| **Uptime** | How long the device has been running since its last reboot. |
Expand Down
2 changes: 1 addition & 1 deletion docs/products/cast1/troubleshooting/cast1-reflash.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ description: Step by step guide for reflashing The CAST-1.

![](/assets/cast-1-boot-mode-method-2.webp)

4\. Open the <a href="https://install.apolloautomation.com/#/cast-1" target="_blank" rel="noreferrer nofollow noopener">Apollo CAST-1 Installer</a>. Under **Variant**, select **WiFi** or **Ethernet** to match your CAST-1.
4\. Open the <a href="https://install.apolloautomation.com/#/cast-1" target="_blank" rel="noreferrer nofollow noopener">Apollo CAST-1 Installer</a>.

5\. Click **Connect & Install**. In the browser popup, select **USB JTAG/serial debug unit** and click **Allow**. When the installer opens, click **Install** to flash the firmware, then click **Install** again to confirm.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your CAST
---
# Reset Wi-Fi Credentials on your CAST-1

!!! note "WiFi firmware only"
!!! note "Using the Ethernet module? Unplug the cable first."

Only the WiFi firmware broadcasts a hotspot. If your CAST-1 runs the Ethernet firmware it won't broadcast a hotspot, so these steps don't apply.
Your CAST-1 doesn't broadcast its hotspot while an Ethernet cable is connected, so take the cable out before you start.

1\. Plug the CAST-1 into power.

Expand Down
1 change: 0 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,6 @@ nav:
- Getting Started: products/cast1/setup/getting-started.md
- Additional Info:
- Sensor Definitions: products/cast1/setup/sensor-definitions.md
- Switch Firmware: products/cast1/setup/cast1-switch-firmware.md
- ESPHome Device Builder: products/cast1/additional-info/esphome-device-builder.md
- Addons:
- Ethernet Module: products/cast1/addons/ethernet-module.md
Expand Down