Install EchoLocal
echolocal installs EchoLocal on the Echo over USB and connects it to your Wi‑Fi.
Get echolocal
Section titled “Get echolocal”Download echolocal for your computer from the
latest release. It’s a single file. During
install it downloads the EchoLocal build and boot image for your Echo, so the computer needs internet
access.
cd ~/Downloadsmv echolocal_darwin_arm64 echolocalchmod +x echolocalxattr -d com.apple.quarantine echolocalOn an Intel Mac, the file is echolocal_darwin_x86_64.
cd ~/Downloadsmv echolocal_linux_x86_64 echolocalchmod +x echolocalOn ARM, such as a Raspberry Pi, the file is echolocal_linux_arm64.
In PowerShell:
cd ~\DownloadsRename-Item echolocal_windows_x86_64.exe echolocal.exeOn an ARM PC, the file is echolocal_windows_arm64.exe. Use .\echolocal.exe wherever this
guide says ./echolocal.
Install
Section titled “Install”Plug the Echo in over USB and run:
./echolocal install --name kitchenThe installer detects the device, flashes its boot image, installs EchoLocal, and asks for your Wi‑Fi if the Echo isn’t on a network yet. The Echo reboots along the way; leave the cable in until it finishes.
The name is what Home Assistant calls the device. Renaming it later makes Home Assistant see a new device, so pick a name you’ll keep.
Options
Section titled “Options”| Option | What it does |
|---|---|
--name kitchen |
Name the device without being asked |
--ssid MyWiFi --password … |
Join this network without scanning |
--wps |
Join by pressing your router’s WPS button |
--yes |
Don’t ask before flashing the boot image |
--reboot, --no-reboot |
Reboot at the end without asking, or finish without rebooting |
--serial G0XXXXXXXX |
Pick an Echo when more than one is plugged in |
--generate-key |
Make the encryption key here, to paste into Home Assistant, instead of letting Home Assistant set it |
--reflash |
Flash the boot image again even if it’s already there |
Other commands
Section titled “Other commands”| Command | What it does |
|---|---|
./echolocal wifi |
Change Wi‑Fi networks (below) |
./echolocal status |
What’s installed and whether it’s running |
./echolocal restart |
Restart EchoLocal |
./echolocal board |
Which Echo this is |
./echolocal key show |
Print the Home Assistant encryption key |
./echolocal key rotate |
Make a new key and restart |
Changing Wi‑Fi later
Section titled “Changing Wi‑Fi later”./echolocal wifi --force--force lists the networks even when the Echo is already connected; without it, a connected Echo
just reports where it is. It takes the same --ssid, --password, --wps and --serial options.
Once the new network connects, the Echo forgets every other network; if it does not connect, the
Echo goes back to the one it was on.
Next: add it to Home Assistant.