Write firmware that supports USB setup

Install your firmware file from the setup card. To receive the settings entered there, your firmware must support USB setup.

Install your file

Open Edit firmware and select My firmware file. Choose the file and the address required by your build. Review the setup, then press its action button.

Your file is read in this browser tab and sent to the board over USB. It is not uploaded: there is no endpoint for it to travel to, and it never reaches Warblet.

Receive setup over USB

Implement CHIRP-PROV to receive network settings and device access over USB. Installation checks the new firmware before sending setup.

USB setup protocol — the whole specification, with reference implementations in MicroPython and Arduino.

Install without sending setup

Turn off Send setup after installation. Your entered settings remain on the card and are not sent.

If USB setup is unavailable

The file remains installed. Add USB setup support, or configure your firmware through its own tools.

Addresses and erase options

ESP32 over serial. The board is on an ordinary serial port. The address is where your build expects to sit — 0x0 for a merged image that carries its own bootloader and partition table, 0x10000 for an application partition on its own, or whatever your build system prints.

STM32 over USB DFU. Use the address required by your build. Enter USB DFU through your board's bootloader procedure. STM32 bootloader help. The F1 series has no USB DFU in ROM and cannot be reached this way.

Flash is erased by sector. Data outside the file but inside a covered sector is erased too.

Erase all flash removes saved settings as well.

After installation

Installation does not prove your firmware has started. If it supports CHIRP-PROV, select its serial console to continue setup.