Raspberry Pi Pico-series Project Template

As the title says, this repo is a project template for working with the Raspberry Pi Pico-series of devices. To begin using this project template do the following:

Make a pico workspace directory on your machine

mkdir picoWorkspace && cd picoWorkspace

Clone the following repos to your workspace: pico-sdk

git clone git@github.com:raspberrypi/pico-sdk.git --recurse-submodules

pico-examples

git clone git@github.com:raspberrypi/pico-examples.git

picotool

git clone git@github.com:raspberrypi/picotool.git

If you would like to use freeRTOS in your project, or build the examples with freeRTOS, clone the freeRTOS kernel synchronous multi-processing (SMP) branch to the root of your workspace directory like so,

git clone -b smp https://github.com/FreeRTOS/FreeRTOS-Kernel --recurse-submodules

If you would like to use CppUTest for unit testing

git clone git@github.com:cpputest/cpputest.git

and switch to tag v4.0

This repo is a GitHub Template Repository. Therefore, you can create your project repository by clicking the Use this template button next to the Star button. This will allow you to name your new repository appropriately for your project and start with the existing directory structure and files that this repo has.

After creating your new project repo from this template, clone your repo to the root of the workspace created above. You will probably want to update the README, LICENSE, and CONTRIBUTING md files for your project as the first commit to your new project.

If you would like to contribute to this Template Repository, See Contributing

Workspace Directory structure

cpputest

C/C++ unit testing framework See README here

FreeRTOS-Kernel

Synchronous multiprocessing (SMP) branch of the FreeRTOS Kernel. See README here

pico-examples

Examples for the RaspberryPi Pico-series using the pico-sdk. See README here

pico-sdk

Software Development Kit for the RaspberryPi Pico-series. See README here

picotool

picotool is a tool for working with RP2040/RP2350 binaries, and interacting with RP2040/RP2350 devices when they are in BOOTSEL mode. (As of version 1.1 of picotool it is also possible to interact with devices that are not in BOOTSEL mode, but are using USB stdio support from the Raspberry Pi Pico SDK by using the -f argument of picotool). See README here

pico-project-xyz

Your copy of this template repository with your project name. The following is a description of the directories for this template repository.

docs

For project documentation

src

For project src

tests

For project testing/unittest

tools

• cmake
  • The cmake shell scripts are a collection of commands for using cmake to configure and build pico series projects using the sdk. The scripts are a consolidation and customization of the cmake command examples found in the documentation from https://www.raspberrypi.com/documentation/.
  • The scripts should be run from the root of your project directory, i.e. same location as this README.
  • Note: All scripts have only been tested on the following environments to date.
    • WSL2/Ubuntu
    • MSYS2/UCRT
  • They should work just fine on any Unix based platform.
• ozone
  • This directory holds Ozone project files for the app and a few pico-examples.

Using the ./tools/cmake scripts

CMake has a two step process; configure then build. Once you configure, only build needs to be used unless you clean or add new files, etc.

All scripts should be run from the root of your project directory, i.e. same location as this README.

Scripts must be made executable by using

• chmod +x script.sh

Notes on Configuring

• The config script configures cmake build with given build type, directory and board.
• The build type, directory and board arguments are required
• For projects using Bluetooth, the mode can be passed in as the 4th argument and the 5th argument must be - NULL (don't type in NULL, just don't enter a fifth arg).
• Bluetooth stack operating modes are; background, poll, or freertos.
• For projects using wifi, the ssid and pwd can be passed as the 4th and 5th args
• When configuring the tests build, only the build type and directory is required.

Basic examples

Configure

• ./tools/cmake/config.sh Debug pico-examples pico(_w) or
• ./tools/cmake/config.sh Debug src pico(_w) or
• ./tools/cmake/config.sh Debug tests

Build

• ./tools/cmake/build.sh Debug pico-examples or
• ./tools/cmake/build.sh Debug src or
• ./tools/cmake/build.sh Debug tests

Clean

• ./tools/cmake/clean.sh Debug pico-examples or
• ./tools/cmake/clean.sh Debug src or
• ./tools/cmake/clean.sh Debug tests

Documentation

Raspberry Pi Pico-series Documentation

Software development with Raspberry Pi Pico-series

This project template was developed using information found in the following documentation:

Getting started with Raspberry Pi Pico-series

• Doesn't hurt to read the whole thing, however, the following sections I found most useful
  • Chapter 1. Introduction
  • Appendix B: Picotool
  • Appendix C: Manual toolchain setup

Raspberry Pi Pico-series C/C++ SDK

Connecting to the Internet with Raspberry Pi Pico W

• Brief easy read like the getting started one, but for pico_w and introduces connecting to wifi and basics of Bluetooth

Hardware development with Raspberry Pi Pico-series

RP2040

RP2040 Datasheet

Hardware design with RP2040

RP2350

RP2350 Datasheet

Hardware design with RP2350