Quick start

1. Prepare the build environment

Install the toolchain and dependencies used by the repository:

sudo apt-get update
sudo apt-get install -y cmake gcc-arm-none-eabi libnewlib-arm-none-eabi build-essential

Then bootstrap the Pico SDK and local dependencies:

./scripts/bootstrap-pico.sh

Note

The project expects the Pico SDK under .deps/pico-sdk and the littlefs sources under .deps/littlefs.

2. Configure the firmware build

Use the default board target for a Pico 2 W build:

cmake -S . -B build -DPICO_SDK_PATH=$PWD/.deps/pico-sdk -DPICO_BOARD=pico2_w

To target a Pico W instead:

cmake -S . -B build -DPICO_SDK_PATH=$PWD/.deps/pico-sdk -DPICO_BOARD=pico_w

3. Build the firmware

cmake --build build -j2

The generated build outputs are written to build/ as .uf2, .elf, .bin, and .hex artifacts.

4. Flash and test the device

1. Put the Pico into USB bootloader mode.
2. Copy the generated .uf2 image to the mounted drive.
3. Open the serial console at the configured baud rate.
4. Configure the Wi‑Fi network and hostname as needed.

5. Configure the device over serial

After the first boot, configure the device with serial commands:

wifi <ssid> [<password>]
hostname <name>
date on|auto|off

Example:

wifi GuestNetwork secretpass
hostname desk-clock
date auto

The wifi command stores the credentials persistently. The hostname and date commands control the device identity and date display behaviour.