Getting Started

Setup a Local Development Environment

west init -m git@github.com:Allegra42/ZEReader.git zereader-workspace

cd zereader-workspace
source .venv/bin/activate

west update
pip install -r zephyr-rtos/scripts/requirements.txt
cd zephyr-rtos
west sdk install

Build the Firmware Binary

Always source the venv environment first!

cd zereader-workspace
source .venv/bin/activate

cd ZEReader

Raspberry Pi Pico 1 with a Device Tree Overlay

west build -b rpi_pico app -p

Raspberry Pi Pico 2 with a Device Tree Overlay

west build -b rpi_pico2/rp2350a/m33 app -p

ZEReader PCB based on Pico 2

west build -b zereader_rev1/rp2350a/m33 app -p always

Flash the Microcontroller

For the Raspberry Pi Pico controllers with UF2 binaries, do

Disconnect USB.
Press the BOOTSEL button during reconnecting. The device shows up as a mass storage.
Copy the build/zephyr/zephyr.uf2 binary onto the device. It will flash the binary into the correct location and restarts.

Build the Documentation

Sphinx (Project Documentation)

cd doc
make html

Doxygen (API Documentation)

cd doc
doxygen

Update Zephyr and Zephyr-Modules

west update