Repository files navigation

PicoFramework brings a modern, expressive architecture to the world of embedded development in C++. Inspired by Express.js and designed specifically for microcontrollers, PicoFramework makes it easy to build web-connected applications on theRaspberry Pi Pico. The first platform available is the Raspberry Pi Pico.

With a modular design, a full HTTP server, flexible routing, middleware, JWT authentication, and JSON storage services — all optimized for embedded constraints — PicoFramework offers a professional, scalable foundation for building robust IoT and control applications.

Full Documentation → https://Pico-Framework.com

Define structured HTTP endpoints using method + path macros, with clean controller logic. Includes route variables, query parsing, file uploads, middleware, and automatic JSON encoding. You write simple, readable handlers that are easy to test and reason about.

GET("/api/v1/zones", handleZones);staticvoidhandleZones(HttpRequest& req, HttpResponse& res){    res.json(getAllZones());// Sends 200 OK + application/json}

Built-in JSON Web Token (JWT) support enables secure authentication without needing extra tooling. Easily protect routes using middleware. Works with any frontend, see the authorization_route example.

Abstract away the details of flash vs SD. Switch between LittleFS (internal flash) and FatFs (SD card) via a singleStorageManager interface. Save binary files or structured JSON settings withJsonService.

Store user preferences, schedules, or app state in structured files. Supports typed loading, atomic save, and directory listing. TheFrameworkModel class provides easy record management.

Schedule events at fixed times or on repeating patterns. Define jobs like:

• "Start zone 3 at 7:00am on Mon/Wed/Fri"
• "Stop after 10 minutes"

Timers post events back to your controllers or use callbacks at a scheduled time.

TheEventManager provides publish/subscribe event delivery. Events can be dispatched from tasks or ISRs, and consumed in controller-specific handlers. Avoid global state and deeply coupled logic.

Serve HTML, CSS, JS, and images directly from flash or SD. Supports gzipped files and chunked transfer. Multipart upload support lets you update files live via browser.

Run CppUTest-based unit tests on-device under FreeRTOS. Mocha is used for end-to-end testing.

PicoFramework is a product-grade runtime for shipping connected systems. It's already been used for:

• Smart irrigation and zone control
• Interactive on-device dashboards
• Time-triggered automation and GPIO switching
• Local web configuration panels
• File uploads and logs over HTTP

You can write maintainable apps that combine web behavior, structured configuration, and tight control logic — without patching together libraries.

All examples build cleanly under FreeRTOS and use the same controller/View pattern as your app will.

PicoFramework follows a clear and minimal philosophy:

• Build once, run reliably — Everything in the framework is designed for real-time embedded use. No surprises. No guesswork.
• No tangled glue code — The architecture gives you clear components: controller, view, model, service.
• Test early and safely — You can write actual unit tests that run on real hardware.
• Event-driven logic, not polling loops — Framework tasks wait on notifications, not spin or delay.
• Use what you need — Every feature is modular. Storage, auth, upload, file server — only link what you use.

Clone the framework and build an example:

git clone https://github.com/Pico-Framework/pico-framework.gitcd Pico-Framework/examples/hello_framework# Follow the README inside each example for specific build/setup instructions

You'll need:

• The Raspberry Pi Pico SDK
• FreeRTOS for RP2040 (already integrated)
• A supported toolchain (e.g. Arm GNU 14.2)

For full setup walkthroughs, see the docs:
https://Pico-Framework.com/docs/getting-started

The full user guide, component reference, architecture notes, and examples are available online:

https://Pico-Framework.com

This includes:

• Getting started with flashing and SD cards
• Writing controllers and views
• StorageManager and JsonService
• Testing framework details
• Embedded file builds and upload handling
• Wi-Fi configuration and resilience logic
• Event system design

• RP2040 (e.g. Pico W)
• RP2350 (e.g. Raspberry Pi Pico 2 W, non-secure FreeRTOS mode)
• Compatible boards, although some features can be used without Wi-Fi. This is designed for connected boards.

Other ports (e.g., STM32, ESP32) are planned but not yet supported.

MIT License
© Ian Archbell, 2024–2025

We welcome issues, improvements, and architecture feedback. However, the first focus is ensuring this first early release meets the needs of the community so I am not planning large new feature releases. Everything will be incremental. This project is structured, maintained, and evolving with care. Please open a discussion before submitting major feature changes.

Build confidently. Host dashboards. Automate reliably.
All from the Raspberry Pi Pico.

• Embedded Control Panels (e.g., sprinkler systems, lighting controllers, home automation)
• IoT Gateways & Edge Devices
• Diagnostics Dashboards
• Secure Configuration Interfaces
• Lab Tools & Instrumentation

Visit the GitHub repository:
👉https://github.com/ianarchbell/Pico-Framework

or the full documentation athttps://Pico-Framework.comYou'll find:

• Quick start guides
• Code examples
• Ready-to-run demo projects
• Documentation on tasks, routes, events, and configuration

PicoFramework is released under theMIT License to maximize adoption, contributions, and commercial flexibility.

Want to contribute or collaborate? Open an issue or pull request on GitHub, or email us at:
📩ian@pico-framework.com

PicoFramework brings structure, scalability, and modern design patterns to the embedded world.