Flash the frame

You install the firmware once over USB. After that, updates install over Wi-Fi.

Tip

Ready-made frames come with the firmware installed. See Set up your frame.

Install the firmware

1. Connect the frame to your computer with a USB-C cable.
2. Open your Featherframe webapp in Chrome or Edge on a computer.
3. In the Frames list, click ⋯, then USB firmware update.
4. Choose your kit.
5. Install it:
   • Featherframe Cloud: click Connect, and choose your frame's port. Click Install, then enter your Wi-Fi details. Once the frame is on Wi-Fi, the dialog adds it to your account. If it says Not paired over USB, use Pair a frame with the code on the frame's screen.
   • Self-hosted: your webapp can't use USB, because it isn't a secure (https) page. Click Open the flasher. The installer opens at wr.github.io/featherframe/flash with your kit chosen. Click Connect, choose your frame's port, click Install, then enter your Wi-Fi details.

Caution

Erase device removes the frame's saved settings, including Wi-Fi. Leave it off unless you want to reset the frame to factory defaults.

Note

On Featherframe Cloud, if the frame already has the latest firmware and Wi-Fi, Connect adds it to your account. You don't need to install anything.

On a self-hosted server, the frame then shows a six-letter code. Connect it to your server, and it appears at the top of the Frames list.

Connect to your own server

Firmware from the installer starts on Featherframe Cloud, and then shows a six-letter code. To use your own server instead:

1. Hold KEY3 for 3 seconds. The frame opens Featherframe-Setup.
2. On your phone, join Featherframe-Setup.
3. Tap Connect to Wi-Fi. Leave Network and Password blank to keep the frame's Wi-Fi.
4. Under Server, choose Self-hosted.
5. Enter your server's address with http:// and the port, for example http://birdnet.local:8181. Or leave it blank, and the frame finds the server on your network.
6. Tap Save.

When the page says Connected., add the frame in your Featherframe webapp. See Add a frame.

Update the firmware

• One frame: click the frame in the Frames list, click Update available…, then click Update.
• Every frame, automatically: go to Settings → General and turn on automatic updates.

Change Wi-Fi

Hold KEY3 for 3 seconds, and join Featherframe-Setup on your phone. See Change Wi-Fi.

Build it yourself

Install PlatformIO, connect the frame by USB, and run:

cd firmware
pio run -e xiao_ee03 -t upload   # EE03 grayscale kit
pio run -e ee02 -t upload        # EE02 color kit
pio device monitor               # show the frame's log

Next: Add a frame.